This topic provides complete reference information about all of Domino’s public REST API endpoints.
GET
/api/aigateway/v1/audit
Description
Gets AI Gateway audit data given filter input parameters
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointIds | Endpoint IDs to query audit data for | array | query | ||
endpointNames | Endpoint names to query audit data for | array | query | ||
startTime | Start time (iso8601) | string | query | ||
endTime | End time (iso8601) | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/aigateway/v1/endpoints
Description
Get all active Gateway LLMs accessible by the user
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many Endpoints from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Endpoints to fetch. Defaults to fetching all. | integer | query | ||
sortByField | The field by which to sort the list of returned endpoints. Defaults to creation date | string | query | creationDate endpointName endpointType modelProvider modelName | |
shouldSortAscending | Boolean whether to sort Endpoints ascending or descending. Defaults to false (descending). | boolean | query | ||
searchFilter | Search string by which to filter the list of returned endpoints | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/aigateway/v1/endpoints
Description
Create a new a endpoint
Body Parameter
| Name | Description | Required |
|---|---|---|
NewEndpointV1 | Details of the new endpoint to create NewEndpointV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/aigateway/v1/endpoints/{endpointName}
Description
Get a endpoint by name (returns endpoint if user has access and endpoint is active)
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointName | Name of the endpoint to get | string | path | ||
numInputTokens | Number of input tokens sent to the endpoint | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/aigateway/v1/endpoints/{endpointName}
Description
Update a endpoint by name (change endpoint name, endpoint type, model name, model provider, or model config)
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointName | Name of the endpoint to update details for | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedEndpointV1 | Updated endpoint details UpdatedEndpointV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/aigateway/v1/endpoints/{endpointName}/permissions
Description
Get permissions for a endpoint by name
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointName | Name of the endpoint to get permissions for | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/aigateway/v1/endpoints/{endpointName}/permissions
Description
Update permissions for a endpoint by name (add or remove user IDs, or change isEveryoneAllowed)
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointName | Name of the endpoint to update permissions for | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedEndpointPermissionsV1 | Updated endpoint permissions UpdatedEndpointPermissionsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps
Description
List all Apps
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | The id of the project to retrieve apps for. If not provided, all apps will be retrieved. | string | query | ||
name | The name filter for the apps to retrieve. If not provided, all apps will be retrieved. | string | query | ||
includeTemplateApps | Whether to include template apps in the response. Defaults to false. | boolean | query | ||
sortField | The field to sort the apps for. The available fields are: `name` - The name of the app. `lastUpdated` - The last updated timestamp of the app. `status` - The current status of the app. `views` - The number of views the app has in the last 7 days. `lastViewed` - Last time the current user viewed the app (most recent first). Defaults to `lastViewed`. | string | query | name lastUpdated status views lastViewed | |
sortOrder | The order to sort the apps in. Can be `asc` or `desc`. Defaults to `asc`. | string | query | asc desc | |
limit | The maximum number of apps to retrieve. Defaults to no limit. | integer | query | ||
offset | The offset to start retrieving apps from. Defaults to 0. | integer | query | ||
ownerId | Filter apps by owning project owner id. | string | query | ||
status | Filter apps by most recent instance status. Single-select. | string | query | Queued Scheduled Pending Preparing Building Pulling Running Serving StopRequested StopAndDiscardRequested Stopping Finishing Stopped Succeeded Failed Error |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/apps/beta/apps
Description
Create an App
Note
This is a beta endpoint with known limitations.
Body Parameter
| Name | Description | Required |
|---|---|---|
AppCreationRequest | Request to create an app AppCreationRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/vanityUrls/{vanityUrl}
Description
Retrieve an App by Vanity URL
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
vanityUrl | The vanity URL of the app to retrieve. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}
Description
Retrieve an App
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/apps/beta/apps/{appId}
Description
Update an App
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to update. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
AppUpdateRequest | Request to update an app AppUpdateRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/apps/beta/apps/{appId}/access/requests
Description
Request access to an App
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to request access to. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/thumbnail
Description
Retrieve an App's thumbnail image
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve the thumbnail for. | string | path | ||
If-None-Match | Optional ETag to conditionally fetch the thumbnail | string | header |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/apps/beta/apps/{appId}/thumbnail
Description
Create or replace an App's thumbnail
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to upsert the thumbnail for. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpsertAppThumbnailRequest | Base64-encoded thumbnail and content type UpsertAppThumbnailRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Replaced existing thumbnail | |
| 201 | Created | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/apps/beta/apps/{appId}/thumbnail
Description
Delete an App's thumbnail
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to delete the thumbnail for. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | No Content | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/thumbnail/metadata
Description
Retrieve an App's thumbnail metadata as JSON
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve the thumbnail metadata for. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/views
Description
Retrieve an App's Views
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve views for. | string | path | ||
startTimestamp | The start epoch timestamp in milliseconds to retrieve views for. Defaults to 30 days ago. | integer | query | ||
endTimestamp | The end epoch timestamp in milliseconds to retrieve views for. Defaults to the current time. | integer | query | ||
granularity | The granularity in milliseconds to return the timeseries in. Defaults to 1 day. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/versions
Description
List all app versions
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve the versions for. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/apps/beta/apps/{appId}/versions
Description
Create an App Version
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve the versions for. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
AppVersionCreationRequest | Request to create an app version AppVersionCreationRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/versions/{versionId}
Description
Retrieve an App Version
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve a version for. | string | path | ||
versionId | The id of the app version to retrieve. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/apps/beta/apps/{appId}/versions/{versionId}
Description
Update an App Version
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to update a version for. | string | path | ||
versionId | The id of the app version to update. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
AppVersionUpdateRequest | Request to update an app version AppVersionUpdateRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/versions/{versionId}/instances
Description
List all app instances
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve the instances for. | string | path | ||
versionId | The id of the app version to retrieve the instances for. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}
Description
Retrieve an App Instance
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve an instance for. | string | path | ||
versionId | The id of the app version to retrieve an instance for. | string | path | ||
instanceId | The id of the app instance to retrieve. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}
Description
Stop an App Instance
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to stop an instance for. | string | path | ||
versionId | The id of the app version to stop an instance for. | string | path | ||
instanceId | The id of the app instance to stop. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}/logs
Description
Retrieve an App Instance Logs
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve an instance's logs for. | string | path | ||
versionId | The id of the app version to retrieve an instance's logs for. | string | path | ||
instanceId | The id of the app instance to retrieve logs for. | string | path | ||
logType | The type of log to retrieve. The available types of logs are: `complete` - This is the default if the value is not provided. All logs lines displayed in the app instance's runtime environment. `stdout` - Log lines displayed in the stdout of the app instance's runtime environment. `stderr` - Log lines displayed in the stderr of the app instance's runtime environment. `prepareoutput` - Log lines generated by the environment preparing the app instance. Defaults to `complete`. | string | query | complete prepareoutput stdout stderr | |
limit | The maximum number of result to retrieve. Defaults to 10000. | integer | query | ||
offset | The offset from the first result. Defaults to 0. | integer | query | ||
latestTime | The epoch timestamp after which to return logs in nanoseconds. Defaults to 0. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}/realTimeLogs
Description
Retrieve an App Instance Real Time Logs
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to retrieve an instance's real time logs for. | string | path | ||
versionId | The id of the app version to retrieve an instance's real time logs for. | string | path | ||
instanceId | The id of the app instance to retrieve real time logs for. | string | path | ||
logType | The type of log to retrieve. The available types of logs are: `complete` - This is the default if the value is not provided. All logs lines displayed in the app instance's runtime environment. `stdout` - Log lines displayed in the stdout of the app instance's runtime environment. `stderr` - Log lines displayed in the stderr of the app instance's runtime environment. `prepareoutput` - Log lines generated by the environment preparing the app instance. Defaults to `complete`. | string | query | complete prepareoutput stdout stderr | |
limit | The maximum number of result to retrieve. Defaults to 10000. | integer | query | ||
offset | The offset from the first result. Defaults to 0. | integer | query | ||
latestTime | The epoch timestamp after which to return logs in nanoseconds. Defaults to 0. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}/views
Description
Record an App Instance View
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
appId | The id of the app to record a view for. | string | path | ||
versionId | The id of the app version to record a view for. | string | path | ||
instanceId | The id of the app instance to record a view for. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/modelApis/async/v1/{asyncModelId}
Description
Request a prediction from an Async Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
asyncModelId | Id of Async Model | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewAsyncPredictionV1 | Information for new Async Prediction NewAsyncPredictionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 413 | ||
| 422 | ||
| 429 | ||
| 500 |
GET
/api/modelApis/async/v1/{asyncModelId}/{asyncPredictionId}
Description
Retrieve the result of an Async Model prediction
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
asyncModelId | Id of Async Model | string | path | ||
asyncPredictionId | Id of Async Prediction | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/auditevents
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
startTimestamp | unix timestamp in milliseconds | integer | query | ||
endTimestamp | unix timestamp in milliseconds | integer | query | ||
actorId | string | query | |||
actorName | string | query | |||
event | string | query | |||
targetType | all events in which the target's type matches | string | query | dataset | |
targetId | all events in which the target's id matches | string | query | dataset_id | |
targetName | all events in which the target's name matches | string | query | my_dataset_name | |
withinProjectId | events that occurred within the context of a project with this id | string | query | ||
withinProjectName | events that occurred within the context of a project with this name | string | query | ||
sort | a comma separated list of fields, each prefixed with either a + or - to indicates asc or desc (no prefix defaults to asc). The list of supported sort fields are timestamp, actorId, actorName, withinProjectId, withinProjectName, event, targetType, and targetName | string | query | -timestamp,+actorId | |
limit | Maximum number of records to return. | integer | query | ||
offset | Zero-based; indicates how many events to skip over before | integer | query | ||
columns | the name of a column that should be included in the csv download. This parameter can be repeated to include multiple columns. The order in which the column names are provided dictates the order of the columns in the csv. This will cause a 400 if the Accept header is not csv or if the column name is unsupported | string | query | date_time date_time user_name first_name last_name event reason_for_change reason_for_change_additional_info electronically_signed target_name project_name dataset_name file_name target_user before_value after_value feature_flag jobs environment workspace |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Provides audit events matching the specified filters and within the specified offset and limit | |
| 400 | Bad request |
GET
/api/cost/v1/billingtags
Description
Get billing codes that a user can see.
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/cost/v1/billingtags
Description
Upsert billing codes.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewBillingTagsV1 | Billing codes to upsert NewBillingTagsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v1/billingtags/{tag}
Description
Get billing tag by tag name.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
tag | tag of the billing tag to archive | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v1/billingtagSettings
Description
Get billing tags setting
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PUT
/api/cost/v1/billingtagSettings
Description
Update billing tags setting
Body Parameter
| Name | Description | Required |
|---|---|---|
BillingTagsSettingsV1 | undefined BillingTagsSettingsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v1/allocation
Description
Retrieve cost allocation
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
start | Start time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
end | End time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
accumulate | If the result will be accumulated. Default is false. If true, the result will be accumulated from the start time to the end time. | boolean | query | ||
filter | Filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | Determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | The cost to share | string | query | ||
shareLabels | The label to share the cost | string | query | ||
reconcile | If the cost will be reconciled | boolean | query | ||
shareTenancyCosts | If the tenancy costs will be shared | boolean | query | ||
idle | If the idle cost will be calculated | boolean | query | ||
external | If the external cost will be calculated | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success |
GET
/api/cost/v1/allocation/summary
Description
Retrieve cost allocation summary. Faster than the full allocation, but may include less details.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
accumulate | if the result will be accumulated. Default is false. If true, the result will be accumulated from the start time to the end time. | boolean | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | the cost to share | string | query | ||
shareLabels | the label to share the cost | string | query | ||
reconcile | if the cost will be reconciled | boolean | query | ||
shareTenancyCosts | if the tenancy costs will be shared | boolean | query | ||
idle | if the idle cost will be calculated | boolean | query | ||
external | if the external cost will be calculated | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v1/asset
Description
Retrieve asset cost
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
start | Start time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
end | End time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
accumulate | If the result will be accumulated. Default is false. If true, the result will be accumulated from the start time to the end time. | boolean | query | ||
filter | Filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success |
PUT
/api/cost/v1/athenaConfigs
Description
Set AWS Billing API Configuration
Body Parameter
| Name | Description | Required |
|---|---|---|
AthenaBillingConfigsV1 | AWS Billing API Config AthenaBillingConfigsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v1/cloudCost
Description
Retrieve cloud cost
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | window=3d | |
costMetric | Determines which cloud cost metric type will be returned. Acceptable values are AmortizedNetCost, InvoicedCost, ListCost, and NetCost. Default is AmortizedNetCost. | string | query | AmortizedNetCost InvoicedCost ListCost NetCost | |
aggregate | Field by which to aggregate the results. Accepts: invoiceEntityID, accountID, provider, service, and label:<name>. Supports multi-aggregation using comma-separated lists. Example: aggregate=accountID,service | string | query | ||
filterInvoiceEntityIDs | Filter for account | string | query | ||
filterAccountIDs | GCP only, filter for projectID | string | query | ||
filterProviders | Filter for cloud service provider | string | query | ||
filterProvidersID | Filter for resource-level ID given by CSP | string | query | ||
filterServices | Filter for cloud service | string | query | ||
filterCategories | Filter based on object type | string | query | ||
filterLabels | Filter for a specific label. Does not support filtering for multiple labels at once | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PUT
/api/cost/v1/licenseKey
Description
Add kubecost license key
Body Parameter
| Name | Description | Required |
|---|---|---|
KubecostLicenseV1 | Kubecost License Key KubecostLicenseV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/allocation
Description
Retrieve cost allocation v2
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | array | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | the cost to share | string | query | ||
shareLabels | the label to share the cost | string | query | ||
reconcile | if the cost will be reconciled | boolean | query | ||
shareTenancyCosts | if the tenancy costs will be shared | boolean | query | ||
idle | if the idle cost will be calculated | boolean | query | ||
external | if the external cost will be calculated | boolean | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/allocation/accumulated
Description
Retrieve cost allocation accumulated v2
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | array | query | ||
interval | Interval to accumulate the costs. Accepts hour, day, week | string | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | the cost to share | string | query | ||
shareLabels | the label to share the cost | string | query | ||
reconcile | if the cost will be reconciled | boolean | query | ||
shareTenancyCosts | if the tenancy costs will be shared | boolean | query | ||
idle | if the idle cost will be calculated | boolean | query | ||
external | if the external cost will be calculated | boolean | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/allocation/summary
Description
Retrieve cost allocation summary. Faster than the full allocation, but may include less details.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | array | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | the cost to share | string | query | ||
shareLabels | the label to share the cost | string | query | ||
reconcile | if the cost will be reconciled | boolean | query | ||
shareTenancyCosts | if the tenancy costs will be shared | boolean | query | ||
idle | if the idle cost will be calculated | boolean | query | ||
external | if the external cost will be calculated | boolean | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/allocation/summary/accumulated
Description
Retrieve accumulated cost allocation summary. Faster than the full allocation, but may include less details.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | array | query | ||
interval | Interval to accumulate the costs. Accepts hour, day, week | string | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
shareIdle | if the idle cost will be shared | boolean | query | ||
shareNamespaces | list of namespaces to share the costs | string | query | ||
shareSplit | determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
shareCost | the cost to share | string | query | ||
shareLabels | the label to share the cost | string | query | ||
reconcile | if the cost will be reconciled | boolean | query | ||
shareTenancyCosts | if the tenancy costs will be shared | boolean | query | ||
idle | if the idle cost will be calculated | boolean | query | ||
external | if the external cost will be calculated | boolean | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/asset
Description
Retrieve asset cost v2
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | array | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset | string | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/asset/accumulated
Description
Retrieve accumulated asset cost v2
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cost allocation. Accepts kubecost aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | array | query | ||
interval | Interval to accumulate the costs. Accepts hour, day, week | string | query | ||
filter | filter the result by the kubecost filter like cluster, namespace, pod, deployment, service, daemonset, statefulset | string | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/cloudCost
Description
Retrieve cloud cost V2
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cloud costs. Accepts kubecost aggregates like invoiceEntityID, accountID, provider, service, and label:<name>. Supports multi-aggregation. | array | query | ||
filter | filter the result by any category which you can aggregate by. | string | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/cost/v2/cloudCost/accumulated
Description
Retrieve accumulated cloud cost V2
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
window | Duration of time over which to query. Accepts words like today, week, month, yesterday, lastweek, lastmonth; durations like 30m, 12h, 7d, or time like 2021-03-10T00:00:00Z,2021-03-11T00:00:00Z | string | query | ||
aggregate | Aggregate the cloud costs. Accepts kubecost aggregates like invoiceEntityID, accountID, provider, service, and label:<name>. Supports multi-aggregation. | array | query | ||
interval | Interval to accumulate the costs. Accepts hour, day, week | string | query | ||
filter | filter the result by any category which you can aggregate by. | string | query | ||
limit | Max number of rows to fetch. Defaults to 1000. | integer | query | ||
offset | How many rows from the start to skip. Defaults to 0. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/metricAlerts/v1
Description
Send a metric out of range alert for a monitored model. Required Permissions: `ViewMonitoringResults`
Body Parameter
| Name | Description | Required |
|---|---|---|
MetricAlertRequestV1 | Details about the metric alert to send MetricAlertRequestV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/metricValues/v1
Description
Log metric values. Required Permissions: `RegisterMonitoringDataset`
Body Parameter
| Name | Description | Required |
|---|---|---|
NewMetricValuesEnvelopeV1 | List of metric values to log NewMetricValuesEnvelopeV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/metricValues/v1/{modelMonitoringId}/{metric}
Description
Retrieve metric values. Required Permissions: `UpdateMonitoringSettings`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelMonitoringId | ID of the monitored model | string | path | ||
metric | Name of the metric to retrieve | string | path | ||
startingReferenceTimestampInclusive | Timestamp to filter metrics by referenceTimestamp >= startingReferenceTimestampInclusive. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | string | query | ||
endingReferenceTimestampInclusive | Timestamp to filter metrics by referenceTimestamp <= endingReferenceTimestampInclusive. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasource/v1/audit
Description
Gets Data Source audit data given filter input parameters
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
dataSourceIds | Data Source IDs to query audit data for | array | query | ||
dataSourceNames | Data Source names to query audit data for | array | query | ||
eventKinds | events to query - AccessDataSource, CreateDataSource, DataSourceAssociatedToProject, DataSourceDissociatedFromProject, DataSourceChangeOfOwnership, DataSourceChangeOfPermissions, DeleteDataSource | array | query | ||
startTime | Start time (iso8601) | string | query | ||
endTime | End time (iso8601) | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasource/v1/datasources
Description
Get Data Sources that a user has access to based on Data Source permissions and input filters
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
dataSourceNames | Names of the Data Sources to get | array | query | ||
offset | How many Data Sources from the start to skip, sorted by descending ID order. Defaults to 0 | integer | query | ||
limit | Maximum number of Data Sources to fetch. Defaults to 10 | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/datasource/v1/datasources
Description
Create a Data Source
Body Parameter
| Name | Description | Required |
|---|---|---|
NewDataSourceV1 | Data Source to create NewDataSourceV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasource/v1/datasources/{dataSourceId}
Description
Gets Data Source by ID. Requires access to Data Source
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
dataSourceId | ID of Data Source to get | string | path | 62604702b7e5d347dbe7a909 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/datasource/v1/datasources/{dataSourceId}
Description
Update Data Source with specified ID. If the current user is not an admin, then only their individual credentials are updated. Otherwise, the shared credentials are updated. If updating a Starburst-powered Data Source, please remember to restart the Starburst cluster in the UI for the changes to take effect. Requires Data Source management privileges
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
dataSourceId | ID of Data Source to update | string | path | 62604702b7e5d347dbe7a909 |
Body Parameter
| Name | Description | Required |
|---|---|---|
DataSourceUpdateV1 | Users and projects to add and remove DataSourceUpdateV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/datasource/v1/datasources/{dataSourceId}
Description
Delete Data Source with specified ID. Requires Data Source ownership privileges
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
dataSourceId | ID of Data Source to delete | string | path | 62604702b7e5d347dbe7a909 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasetrw/v1/datasets
Description
Deprecated: Use GetDatasetsV2. Get Datasets that a user has access to
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID filter | string | query | ||
offset | How many Datasets from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Datasets to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/datasetrw/v1/datasets
Description
Create a new Dataset. Requires access to the project the dataset will originate from
Body Parameter
| Name | Description | Required |
|---|---|---|
NewDatasetRwV1 | Dataset to create NewDatasetRwV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasetrw/v1/datasets/{datasetId}
Description
Get Dataset by ID. Requires List access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to retrieve | string | path | 62604702b7e5d347dbe7a909 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/datasetrw/v1/datasets/{datasetId}
Description
Update Dataset name or description. Requires Update access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to update | string | path | 62604702b7e5d347dbe7a909 |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwMetadataV1 | Fields to update DatasetRwMetadataV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasetrw/v1/datasets/{datasetId}/grants
Description
Get Dataset grants by ID. Requires List access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to get grants for | string | path | 62604702b7e5d347dbe7a909 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/datasetrw/v1/datasets/{datasetId}/grants
Description
Add a grant to a dataset's existing sequence of grants. Requires EditSecurity access to the dataset.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to add a grant to | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwGrantV1 | Grant to add DatasetRwGrantV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/datasetrw/v1/datasets/{datasetId}/grants
Description
Remove a grant from a dataset's existing sequence of grants. Requires EditSecurity access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to remove the grant from | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwGrantV1 | Grant to remove DatasetRwGrantV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasetrw/v1/datasets/{datasetId}/snapshots
Description
Get Snapshots belonging to a dataset. Requires List access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | ID of dataset to retrieve snapshots for | string | path | 62604702b7e5d347dbe7a909 | |
offset | How many Snapshots from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Snapshots to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/datasetrw/v1/datasets/{datasetId}/snapshots
Description
Create a new Snapshot in a dataset. Requires Read access to the dataset and project access
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | Dataset ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewSnapshotV1 | Snapshot to create NewSnapshotV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/datasetrw/v1/datasets/{datasetId}/tags
Description
Tag a snapshot in this Dataset with the given tagName. Requires Update access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | Dataset ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetRwTagToAddV1 | Tag name and snapshot ID to apply it to DatasetRwTagToAddV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/datasetrw/v1/datasets/{datasetId}/tags/{tagName}
Description
Remove a Tag from a dataset. Requires Update access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasetId | Dataset ID | string | path | ||
tagName | Name of tag to delete | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/datasetrw/v2/datasets
Description
Get Datasets that a user has access to based on dataset permissions and input filters
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
minimumPermission | Filter for minimum dataset permission the principal needs to have in returned datasets. | string | query | DeleteDatasetRwV2 EditSecurityDatasetRwV2 ListDatasetRwV2 PerformDatasetRwActionsInProjectV2 PermanentDeleteDatasetRwV2 ReadDatasetRwV2 UpdateDatasetRwV2 PerformDatasetRwActionsAsAdminV2 | |
projectIdsToExclude | ProjectIds of datasets to exclude from result. | array | query | ||
projectIdsToInclude | ProjectIds to get the datasets from. Should not be passed in if projectIdsToExclude is and vice versa. | array | query | ||
includeProjectInfo | Boolean to determine whether or not to return project-info in return objects. | boolean | query | ||
offset | How many Datasets from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Datasets to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/admin/v1/deploymentTargets
Description
Gets all non-archived Deployment Targets based on the provided filters.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
name | Filter by Deployment Target name | string | query | ||
deploymentType | Filter by deployment type | string | query | ||
offset | How many Deployment Targets from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Deployment Targets to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/admin/v1/deploymentTargets
Description
Creates a new Deployment Target.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewDeploymentTarget | Details of the Deployment Target to create NewDeploymentTarget |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/admin/v1/deploymentTargets/selectable
Description
Gets all selectable non-archived Deployment Targets based on the provided filters.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
name | Filter by Deployment Target name | string | query | ||
deploymentType | Filter by deployment type | string | query | ||
offset | How many Deployment Targets from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Deployment Targets to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/admin/v1/deploymentTargets/{deploymentTargetId}
Description
Gets a Deployment Target.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of Deployment Target | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/admin/v1/deploymentTargets/{deploymentTargetId}
Description
Updates a Deployment Target.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of Deployment Target | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedDeploymentTarget | Details of the Deployment Target to create UpdatedDeploymentTarget |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations
Description
Gets all non-archived Resource Configurations based on the provided filters.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
name | Filter by Resource Configuration name | string | query | ||
offset | How many Resource Configurations from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Resource Configurations to fetch. Defaults to 10. | integer | query | ||
deploymentTargetId | ID of Deployment Target that Resource Configuration belongs to. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations
Description
Creates a new Resource Configuration.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of Deployment Target that Resource Configuration belongs to. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewResourceConfiguration | Details of the Resource Configuration to create NewResourceConfiguration |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}
Description
Gets a Resource Configuration.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of the Deployment Target that Resource Configuration belongs to. | string | path | ||
resourceConfigurationId | ID of the Resource Configuration. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}
Description
Updates a Resource Configuration.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of the Deployment Target that Resource Configuration belongs to. | string | path | ||
resourceConfigurationId | ID of the Resource Configuration. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedResourceConfiguration | Details of the Resource Configuration to create UpdatedResourceConfiguration |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}
Description
Deletes a Resource Configuration.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of the Deployment Target that Resource Configuration belongs to. | string | path | ||
resourceConfigurationId | ID of the Resource Configuration. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Deleted | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}/effectiveModelDeploymentSchema
Description
Gets the effective configuration for model deployments using the resource configuration.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
deploymentTargetId | ID of Deployment Target the Resource Configuration belongs to | string | path | ||
resourceConfigurationId | ID of Resource Configuration | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/environments/beta/environments
Description
Get environments that a user can see. Required permissions: `None`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many Environments from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Environments to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/environments/beta/environments
Description
Create an environment. Required permissions: `CreateEnvironment, EditEnvironment, UseFileStorage`.
Note
This is a beta endpoint with known limitations.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewEnvironmentV1 | Environment to create NewEnvironmentV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/environments/beta/environments/{environmentId}/revisions
Description
Create a revision of an environment. Required permissions: `ManageEnvironments, EditEnvironment, UseFileStorage`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to create revision of | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewEnvironmentRevisionV1 | Environment revision to create NewEnvironmentRevisionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/environments/beta/environments/{environmentId}/revisions/{revisionId}
Description
Update a revision of an environment to mark if isRestricted. Required permissions: `ClassifyEnvironments`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to mark restricted revision | string | path | ||
revisionId | Id of environment revision to mark is restricted | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdateEnvironmentRevisionV1 | Body of isRestricted UpdateEnvironmentRevisionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/environments/v1/environments/{environmentId}
Description
Get an Environment by its Id. Required permissions: `ViewEnvironment`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/environments/v1/environments/{environmentId}
Description
Archive an Environment, removing it from the list of visible environments. Required permissions: `ManageEnvironments, EditEnvironment`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | Id of environment to archive | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/beta/gen-ai/endpoints
Description
Get all Gen AI endpoints
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many Endpoints to skip from the start. Defaults to 0. | integer | query | ||
limit | Max number of Endpoints to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/beta/gen-ai/endpoints
Description
Create a new Gen AI Endpoint
Note
This is a beta endpoint with known limitations.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewModelEndpointV1 | Details of the Gen AI Endpoint to create NewModelEndpointV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/beta/gen-ai/endpoints/{endpointId}
Description
Get endpoint by id
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the endpoint to get | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/beta/gen-ai/endpoints/{endpointId}
Description
Patch an endpoint
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the endpoint to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ModelEndpointPatchV1 | Details of the endpoint to patch ModelEndpointPatchV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/beta/gen-ai/endpoints/{endpointId}
Description
Delete a Gen AI Endpoint
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the endpoint to delete. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | The endpoint was deleted successfully. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/beta/gen-ai/endpoints/{endpointId}/versions
Description
Get the versions for a Gen AI Endpoint
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the endpoint to get | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/beta/gen-ai/endpoints/{endpointId}/versions/{versionId}
Description
Get a Gen AI Endpoint Version
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the Gen AI Endpoint. | string | path | ||
versionId | The ID of the Gen AI Endpoint Version. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The Gen AI Endpoint Version. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/beta/gen-ai/endpoints/{endpointId}/versions/{versionId}/start
Description
Start a Gen AI Endpoint Version
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the Gen AI Endpoint. | string | path | ||
versionId | The ID of the Gen AI Endpoint Version. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | The Gen AI Endpoint Version was started. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/beta/gen-ai/endpoints/{endpointId}/versions/{versionId}/stop
Description
Stop a Gen AI Endpoint Version
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointId | The ID of the Gen AI Endpoint. | string | path | ||
versionId | The ID of the Gen AI Endpoint Version. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | The Gen AI Endpoint Version was stopped. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/hardwaretiers/v1/hardwaretiers
Description
Get all hardware tiers. Required permissions: `ViewHardwareTiers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many hardware tiers from the start to skip. Defaults to 0. | integer | query | ||
limit | How many hardware tiers to fetch. Defaults to 10. | integer | query | ||
includeArchived | Whether to include archived hardware tiers. Defaults to false. | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/hardwaretiers/v1/hardwaretiers
Description
Create a hardware tier. Required permissions: `ManageHardwareTiers`
Body Parameter
| Name | Description | Required |
|---|---|---|
NewHardwareTierV1 | Hardware tier to create NewHardwareTierV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PUT
/api/hardwaretiers/v1/hardwaretiers
Description
Update a hardware tier. Required permissions: `ManageHardwareTiers`
Body Parameter
| Name | Description | Required |
|---|---|---|
HardwareTierV1 | Updated hardware tier HardwareTierV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/hardwaretiers/v1/hardwaretiers/{hardwareTierId}
Description
Get a hardware tier by Id. Required permissions: `ViewHardwareTiers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
hardwareTierId | Id of hardwareTier to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/hardwaretiers/v1/hardwaretiers/{hardwareTierId}
Description
Archive a hardware tier by Id. Required permissions: `ManageHardwareTiers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
hardwareTierId | Id of hardwareTier to archive | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/jobs/beta/jobs
Description
Retrieve all Jobs that belong to a project. Required permissions: `ViewJobs.`
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of project to retrieve Jobs for | string | query | 622a6944dde1a920fcccff0d | |
offset | Number of jobs from the start to skip. Defaults to 0. | integer | query | 2 | |
limit | Total number of Jobs to retrieve. Defaults to 10. | integer | query | 25 | |
sortBy | Field to sort Jobs by. Defaults to "number". | string | query | number title command startedTime duration status user commentCount dominoStatsField | |
dominoStatsSortFieldName | Field in domino stats to sort by. Only used if sortBy = dominoStatsField. | string | query | r-squared | |
ascending | Whether to sort ascending or descending. Defaults to to False. | boolean | query | ||
showArchived | Whether to include archived Jobs in results. Defaults to false. | boolean | query | ||
statusFilter | Status of Jobs to fetch. Defaults to "all". | string | query | all queued running completed archived active | |
tagFilter | Tag to filter by. Must match tag name exactly. | string | query | MyTag |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/jobs/beta/jobs/{jobId}
Description
Retrieve a Job's details by its Id. Required permissions: `ViewJobs`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of Job to retrieve details for | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/jobs/beta/jobs/{jobId}/logs
Description
Retrieve the logs for the Job with the specified Id. Required permissions: `ViewJobs`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to get logs for | string | path | ||
logType | Type of log to retrieve. Case insensitive. | string | query | stdOut stdErr prepareOutput complete | |
limit | Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time. | integer | query | ||
latestTimeNano | The epoch time in nanoseconds to start fetching from | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/jobs/v1/goals
Description
Retrieve goals for a Job with the specified Id. Required permissions: `ViewJobs`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to link to goal | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/jobs/v1/goals
Description
Link the Goal with the specified Id to a Job. Required permissions: `ViewJobs, Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to link to goal | string | query |
Body Parameter
| Name | Description | Required |
|---|---|---|
GoalToLinkV1 | undefined GoalToLinkV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/jobs/v1/goals/{goalId}
Description
Unlink the Goal with the specified Id from a Job. Required permissions: `ViewJobs, Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
goalId | Id of goal to remove | string | path | ||
jobId | Id of job to remove goal from | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/jobs/v1/jobs
Description
Start a new Job. Required permissions: `StartJob, UseGlobalCompute`
Body Parameter
| Name | Description | Required |
|---|---|---|
NewJobV1 | undefined NewJobV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/jobs/v1/jobs/{jobId}/tags
Description
Add a Tag to the Job with the specified Id. Required permissions: `ViewJobs`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to add tag to | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
TagToAddV1 | undefined TagToAddV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/jobs/v1/jobs/{jobId}/tags/{tagId}
Description
Remove a Tag from the Job with the specified Id. Required permissions: `ViewJobs`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
jobId | Id of job to remove tag from | string | path | ||
tagId | Id of tag to remove | string | path | ||
projectId | Id of project that tag belongs to | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/modelServing/v1/modelApis
Description
Lists Model APIs based on the query filters. Returns only Model APIs visible to the requesting user.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
environmentId | The id of the environment to filter the Model APIs by. | string | query | ||
projectId | The id of the project to filter the Model APIs by. | string | query | ||
name | The name of the Model APIs. Can be a regular expression. | string | query | ||
registeredModelName | The name of the registered model that is the source of the Model API. | string | query | ||
registeredModelVersion | The version of the registered model that is the source of the Model API. Can only be present along with registeredModelName. | integer | query | ||
limit | The number of result to retrieve. Defaults to 25. | integer | query | ||
offset | The offset from the first element to start retrieving from. | integer | query | ||
orderBy | Field to order results by. Format is the name of the field optionally followed by a space and either ASC or DESC. If not specified defaults to ASC. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The list of Model APIs matching the provided query. |
POST
/api/modelServing/v1/modelApis
Description
Creates a new Model API with a single Model API version.
Body Parameter
| Name | Description | Required |
|---|---|---|
ModelApiCreationRequest | undefined ModelApiCreationRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | The created Model API. |
GET
/api/modelServing/v1/modelApis/{modelApiId}
Description
Retrieves a single Model API.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to retrieve. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The Model API with the requested id. |
PUT
/api/modelServing/v1/modelApis/{modelApiId}
Description
Updates a Model API.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to update. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ModelApiUpdateRequest | undefined ModelApiUpdateRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The updated Model API. |
GET
/api/modelServing/v1/modelApis/{modelApiId}/versions
Description
Lists the Model API Versions for a Model API.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to list the versions for. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The list of Model API Versions for the given Model API. |
POST
/api/modelServing/v1/modelApis/{modelApiId}/versions
Description
Creates a Model API Version for a Model API.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to create the version for. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ModelApiVersionCreationRequest | undefined ModelApiVersionCreationRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | The created Model API Version. |
GET
/api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}
Description
Retrieves a single Model API Version.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to retrieve the version for. | string | path | ||
modelApiVersionId | The id of the Model API Version to retrieve. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The Model API version with the given id. |
GET
/api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}/buildLogs
Description
Retrieves the build logs for a Model API Version.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to retrieve the build logs for. | string | path | ||
modelApiVersionId | The id of the Model API Version to retrieve the build logs for. | string | path | ||
buildId | build Id of the model API to return build logs for. | string | query | ||
sinceTimeNano | The epoch time in nanoseconds to start fetching from, such as "1543538813745986325". "0" by default and will typically be used for a timestamp-based offset log fetching strategy. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The build logs for the given Model API Version. |
GET
/api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}/exportLogs
Description
Retrieves the export logs for a Model API Version.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to retrieve the export logs for. | string | path | ||
modelApiVersionId | The id of the Model API Version to retrieve the export logs for. | string | path | ||
sinceTimeNano | The epoch time in nanoseconds to start fetching from, such as "1543538813745986325". "0" by default and will typically be used for a timestamp-based offset log fetching strategy. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The export logs for the given Model API Version. |
GET
/api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}/instanceLogs
Description
Retrieves the instance logs for a Model API Version.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelApiId | The id of the Model API to retrieve the instance logs for. | string | path | ||
modelApiVersionId | The id of the Model API Version to retrieve the instance logs for. | string | path | ||
podName | The pod name of the model API instance. | string | query | ||
containerName | The container name of the model API instance. | string | query | ||
sinceTimeNano | The epoch time in nanoseconds to start fetching from, such as "1543538813745986325". "0" by default and will typically be used for a timestamp-based offset log fetching strategy. | string | query | ||
tail | Whether to fetch from tail or not. | boolean | query | ||
maxResults | The maximum number of logs to retrieve. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The instance logs for the given Model API Version. |
GET
/api/modelServing/v1/modelDeployments
Description
Retrieves all Model Deployments filtered by optional query arguments.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
name | The Model Deployment name to search by. | string | query | ||
projectId | The Project Id to filter by. | string | query | ||
deploymentTargetId | The Deployment Target Id to filter by | string | query | ||
resourceConfigurationId | The Resource Configuration Id to filter by | string | query | ||
registeredModelName | The registered model name to filter by | string | query | ||
registeredModelVersion | The registered model version to filter by. If defined, registeredModelName must also be defined | integer | query | ||
limit | The number of results to retrieve. Defaults to 25. | integer | query | ||
offset | The offset from the first element to start retrieving from. | integer | query | ||
orderBy | Field to order results by. Format is the name of the field optionally followed by a space and either ASC or DESC. Field name can be name, type, status, creationTimestamp, or updateTimestamp. If not specified, defaults to "name ASC". | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A list of Model Deployments matching the provided query. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/modelServing/v1/modelDeployments
Description
Creates a new Model Deployment entity.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewModelDeployment | undefined NewModelDeployment |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The created Model Deployment. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/modelServing/v1/modelDeployments/{modelDeploymentId}
Description
Retrieves a specific Model Deployment entity by id.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model Deployment with the requested id. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/modelServing/v1/modelDeployments/{modelDeploymentId}
Description
Update fields of a Model Deployment entity by id.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedModelDeployment | Details of the Model Deployment to update. UpdatedModelDeployment |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model Deployment updated successfully. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/modelServing/v1/modelDeployments/{modelDeploymentId}
Description
Archives a Model Deployment.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment to archive. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Successfully archived the Model Deployment. |
GET
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/credentials
Description
Retrieves summary information for all available temporary credentials of a Model Deployment.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment from which to retrieve credentials | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A non-paginated list of all Model Deployment credentials for a specific Model Deployment. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/credentials/{operationType}
Description
Retrieves information for available temporary credentials of a Model Deployment for a specific operation type.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment | string | path | ||
operationType | The operation type of the credentials | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Credentials for the specific operation type | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/logs/{logSuffix}
Description
Retrieves the logs for a specific Model Deployment entity by id.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment whose logs to retrieve | string | path | ||
logSuffix | Generated suffix for the log key corresponding to the requested logs | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Logs of the Model Deployment with the requested id. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/start
Description
Starts a Stopped or Failed Model Deployment.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment to start. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Successfully started the Model Deployment. |
POST
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/stop
Description
Stops a Running Model Deployment.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment to stop. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Successfully stopped the Model Deployment. |
GET
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/versions
Description
Retrieves summary information for all historical versions of a Model Deployment.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment to update | string | path | ||
limit | The number of result to retrieve. Defaults to 25. | integer | query | ||
offset | The offset from the first element to start retrieving from. | integer | query | ||
orderBy | Field to order results by. Format is the name of the field optionally followed by a space and either ASC or DESC. Field name can be name, type, status, creationTimestamp, or updateTimestamp. If not specified, defaults to "name ASC". | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A paginated list of all Model Deployment versions for a specific Model Deployment. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/modelServing/v1/modelDeployments/{modelDeploymentId}/versions/{version}
Description
Retrieves a specific historical version (Model Deployment entity) of a Model Deployment.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelDeploymentId | The id of the Model Deployment | string | path | ||
version | Version number of the Model Deployment | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Historical version of the Model Deployment found. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/organizations/v1/organizations
Description
Retrieve all Organizations of which this user is a member. Required permissions: `None`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
nameFilter | Optional value to filter organization names with. Must exactly match organization name. | string | query | ||
offset | How many orgs from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of orgs to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/organizations/v1/organizations
Description
Create a new Organization. Required permissions: `Must be logged in user`
Body Parameter
| Name | Description | Required |
|---|---|---|
NewOrganizationV1 | undefined NewOrganizationV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/organizations/v1/organizations/all
Description
Get all organizations. Required permissions: `ManageOrganizations`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
nameFilter | Optional value to filter organization names with. | string | query | ||
userIdFilter | Optional value to filter organizations that only a user belongs to | string | query | ||
offset | How many orgs from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of orgs to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/organizations/v1/organizations/{organizationId}
Description
Retrieve an Organization by its Id. Required permissions: `ViewOrganization`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
organizationId | Id of organization to retrieve. This is the id of the org in the users collection, not the organizations collection. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PUT
/api/organizations/v1/organizations/{organizationId}/user
Description
Add a new user to an Organization. Required permissions: `EditMembers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
organizationId | Id of organization to add a user to. This is the id of the org in the users collection, not the organizations collection. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
OrganizationMemberV1 | undefined OrganizationMemberV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/organizations/v1/organizations/{organizationId}/user
Description
Remove a user from an Organization. Required permissions: `EditMembers`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
organizationId | Id of organization to add a user to. This is the id of the org in the users collection, not the organizations collection. | string | path | ||
memberToRemoveId | Id of user to remove from org. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/projects/beta/projects
Description
Get projects that a user can see. Required permissions: `ListProject`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many Projects from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Projects to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/beta/projects
Description
Create a project. Required permissions: `CreateProject, UseFileStorage`.
Note
This is a beta endpoint with known limitations.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectV1 | Project to create NewProjectV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/projects/beta/projects/{projectId}
Description
Archive a project by id. Required permissions: `ArchiveProject`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/projects/beta/projects/{projectId}/results-settings
Description
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PUT
/api/projects/beta/projects/{projectId}/results-settings
Description
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectResultsSettingsV1 | Project status ProjectResultsSettingsV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v1/projects/{projectId}/collaborators
Description
Add a collaborator to this project. Required permissions: `ManageCollaborators`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectCollaboratorV1 | Collaborator ID ProjectCollaboratorV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/projects/v1/projects/{projectId}/collaborators/{collaboratorId}
Description
Remove a collaborator from the project. Required permissions: `ManageCollaborators`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to remove collaborator from | string | path | ||
collaboratorId | ID of the collaborator to remove | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v1/projects/{projectId}/copy-project
Description
Create a new project by copying an existing project and providing optional overrides. Specify a git repository to link to the copied project or copy the original project's git repository for the copied project.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
CopyProjectSpecV1 | Information needed in order to copy a project. CopyProjectSpecV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 429 | ||
| 500 |
GET
/api/projects/v1/projects/{projectId}/goals
Description
Get goals in this project. Required permissions: `ListProject`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v1/projects/{projectId}/goals
Description
Add a goal to this project. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectGoalV1 | Goal to add NewProjectGoalV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/projects/v1/projects/{projectId}/goals/{goalId}
Description
Update project goal status. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID of the goal | string | path | ||
goalId | ID of the goal to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectGoalForUpdateV1 | Project goal for update ProjectGoalForUpdateV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/projects/v1/projects/{projectId}/goals/{goalId}
Description
Delete a project goal. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to delete goal from | string | path | ||
goalId | ID of the goal to delete | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/projects/v1/projects/{projectId}/repositories
Description
Get all imported git repositories in this project. Required permissions: `ListProject`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path | ||
offset | How many Projects from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Projects to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v1/projects/{projectId}/repositories
Description
Add an imported git repository to this project. Required permissions: `ChangeProjectSettings`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectGitRepositoryV1 | Repository to add NewProjectGitRepositoryV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/projects/v1/projects/{projectId}/repositories/{repositoryId}
Description
Remove an imported repository from the project. Required permissions: `ChangeProjectSettings`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to remove goal from | string | path | ||
repositoryId | ID of the repository to remove | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PUT
/api/projects/v1/projects/{projectId}/status
Description
Update the status of a project. Required permissions: `Edit`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
ProjectStatusV1 | Project status ProjectStatusV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v2/projects
Description
Create a project. Required permissions: `CreateProject, UseFileStorage`.
Body Parameter
| Name | Description | Required |
|---|---|---|
NewProjectV2 | Project to create NewProjectV2 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/projects/beta/projects/{projectId}/files/{commitId}/{path}/content
Description
Return the raw contents of a file in a project at given commit.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of the project to return files for | string | path | ||
commitId | Id of a commit in the project repository to list files from | string | path | ||
path | Path in the project's repository to the file. It must be url-encoded and is case-sensitive. | string | path | nested%2Ffolder%2Ffile.ext |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success. It returns a stream of data with the file content, specifying the appropriate media type based on the file extension in a best-effort basis. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/projects/v1/projects/{projectId}/files/{commitId}/{path}/content
Description
Return the raw contents of a file in a project at given commit.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of the project to return files for | string | path | ||
commitId | Id of a commit in the project repository to list files from | string | path | ||
path | Path in the project's repository to the file. It must be url-encoded and is case-sensitive. | string | path | nested%2Ffolder%2Ffile.ext |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success. It returns a stream of data with the file content, specifying the appropriate media type based on the file extension in a best-effort basis. | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/projects/v1/projects/{projectId}/shared-datasets
Description
List shared datasets used by a project. Required permissions: `GetDatasetsRw`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v1/projects/{projectId}/shared-datasets
Description
Link a shared dataset to this project. Required permissions: `ManageDatasetsRw,UseFileStorage`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
DatasetToAddV1 | Dataset ID DatasetToAddV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
DELETE
/api/projects/v1/projects/{projectId}/shared-datasets/{datasetId}
Description
Unlink the dataset with the specified Id from a project. Required permissions: `ManageDatasetsRw,UseFileStorage`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Id of project | string | path | ||
datasetId | Id of shared dataset to remove | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success |
POST
/api/develop/v1/customer-project-templates
Description
Body Parameter
| Name | Description | Required |
|---|---|---|
NewCustomerTemplate | Project template to create NewCustomerTemplate |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Created | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/develop/v1/customer-project-templates/{id}
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
id | The id of the project template to return. | string | path | ||
includeArchived | If the template is archived and this parameter is set to true, the template will be returned instead of a 404. | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/develop/v1/customer-project-templates/{id}
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
id | The id of the project template to update. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdateCustomerTemplate | Template updates UpdateCustomerTemplate |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/develop/v1/project-templates
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
page | The page number of the collection to return. If not provided, the first page will be returned. | integer | query | ||
size | The number of items to return per page. If not provided, 10 items will be returned per page. | integer | query | ||
view | The view to filter on. To retrieve your own templates, pass your user ID as a string. To retrieve templates shared with you, pass in "shared". To retrieve company official templates, pass in "official". If you have Domino AI Hub templates enabled, you can also pass in "ecosystem" to retrieve those. | string | query | ||
category | The category to filter on. Applies only to ecosystem templates. | string | query | ||
owner | The owner to filter on. Supply user ID for custom templates and owner name for ecosystem templates. | string | query | ||
isCompanyOfficial | boolean | query | |||
orderBy | The field to sort the collection by (in the given order). | string | query | updated name recommended | |
sortOrder | The direction to sort the collection by. The direction is 'desc' by default in all cases. | string | query | asc desc | |
q | The search query to match on a template's name or description. | string | query | ||
tagName | The custom template tag to search for. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1
Description
Get registered models that a user can see.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID of requested models. | string | query | ||
searchPattern | Search parameter to retrieve models from Mlflow (currently supports name and tags) | string | query | ||
pageToken | Pagination token to go to the next page based on a previous search query. | string | query | ||
maxResults | Max number of Registered Models to fetch. Defaults to 25. | integer | query | ||
orderBy | List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by model name ASC. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/registeredmodels/v1
Description
Create a new Registered Model from an experiment run
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelV1 | Details of the registered model to create NewRegisteredModelV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/names
Description
Get a list of Registered Models' names visible to user.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
search | Search filter by model name | string | query | ||
offset | How many Registered Models from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Registered Models to fetch. Defaults to 10. | integer | query | ||
projectId | Project ID of requested models. | string | query | ||
modelCategory | Filter models by category. | string | query | genai ml |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/ui
Description
Get registered models that a user can see.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID of requested models. | string | query | ||
searchPattern | Search parameter to retrieve models from Mlflow (currently supports name and tags) | string | query | ||
globallyDiscoverable | globallyDiscoverable flag to indicate if we want to return globally discoverable models. Defaults to false. | boolean | query | ||
pageToken | Pagination token to go to the next page based on a previous search query. | string | query | ||
maxResults | Max number of Registered Models to fetch. Defaults to 25. | integer | query | ||
orderBy | List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/{modelName}
Description
Get a specific Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
PATCH
/api/registeredmodels/v1/{modelName}
Description
Update a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
PatchRegisteredModelV1 | Details of the model to update PatchRegisteredModelV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/{modelName}/modelapis
Description
Gets all active model Apis that were deployed from a given Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/{modelName}/versions
Description
Get all versions of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
offset | Offset for pagination from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Registered Models to fetch. Defaults to 20 | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/registeredmodels/v1/{modelName}/versions
Description
Create a new version of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelVersionV1 | Details of the model version to create NewRegisteredModelVersionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/{modelName}/versions/{version}
Description
Get a specific version of a Registered Model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v1/{modelName}/versions/{version}/modelapis
Description
Gets all active model Apis that were deployed from a given Registered Model Version
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/registeredmodels/v2
Description
Register a model from various sources using a unified API
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelV2 | Details of the model to register NewRegisteredModelV2 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v2/{modelName}/versions
Description
Get all versions of a Registered Model with optional experiment run ID
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
offset | Offset for pagination from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of Registered Models to fetch. Defaults to 20 | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/registeredmodels/v2/{modelName}/versions/{version}
Description
Get a specific version of a Registered Model with optional experiment run ID
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/serviceAccounts/v1/serviceAccounts
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
includeDeactivated | indicates whether deactivated service accounts should be included in the response | boolean | query | ||
offset | Zero-based; indicates how many events to skip over before | integer | query | ||
limit | Maximum number of records to return. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Lists the service accounts | |
| 400 | ||
| 401 | ||
| 403 |
POST
/api/serviceAccounts/v1/serviceAccounts
Description
Body Parameter
| Name | Description | Required |
|---|---|---|
CreateServiceAccount | undefined CreateServiceAccount |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Creates a service account | |
| 400 | ||
| 401 | ||
| 403 |
GET
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/gitcredentials
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path | |||
offset | Zero-based; indicates how many events to skip over before | integer | query | ||
limit | Maximum number of records to return. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Get the list of Git credentials associated with a service account | |
| 401 | ||
| 403 | ||
| 404 |
DELETE
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/gitcredentials/{credentialId}
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path | |||
credentialId | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Disassociates Git credentials from a service account | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 |
POST
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/passwordgitcredentials
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
PasswordGitCredential | undefined PasswordGitCredential |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Associates Git credentials with a service account | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 |
POST
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/sshgitcredentials
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
SshGitCredential | undefined SshGitCredential |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Associates Git credentials with a service account | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 |
POST
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokengitcredentials
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
TokenGitCredential | undefined TokenGitCredential |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Associates Git credentials with a service account | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 |
GET
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path | |||
offset | Zero-based; indicates how many events to skip over before | integer | query | ||
limit | Maximum number of records to return. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Get the list of tokens associated with a particular service account | |
| 401 | ||
| 403 | ||
| 404 |
POST
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
CreateToken | undefined CreateToken |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Creates a service account token | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 |
GET
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens/{tokenName}
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path | |||
tokenName | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Get the token with the provided name that belongs to a particular service account | |
| 401 | ||
| 403 | ||
| 404 |
POST
/api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens/{tokenName}/invalidate
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
serviceAccountIdpId | string | path | |||
tokenName | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Invalidates a service account | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 |
GET
/api/users/beta/credentials/{userId}
Description
Retrieve a users git credentials. Required permissions: `UpdateUser`.
Note
This is a beta endpoint with known limitations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
userId | Id of the User to fetch creds for | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
GET
/api/users/v1/users
Description
Retrieves all users visible to the current user. Required permissions: `None`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
offset | How many users from the start to skip. Defaults to 0. | integer | query | ||
limit | Max number of users to fetch. Defaults to 10. | integer | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
POST
/api/projects/v1/projects/{projectId}/workspaces/{workspaceId}/sessions
Description
Creates a new session given an existing workspace. Required permissions: `OpenWorkspace`, `UseGlobalCompute`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path | ||
workspaceId | Workspace ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewWorkspaceSessionV1 | New session parameters NewWorkspaceSessionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | ||
| 401 | ||
| 403 | ||
| 404 | ||
| 500 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpointId | String | Endpoint ID | ||
| endpointType | String | Endpoint type | ||
| eventKind | String | Event kind | ||
| metadata | AIGatewayAuditMetadataV1 | |||
| performedBy | String | ID of user who performed the event | ||
| timestamp | String | timestamp of when event was performed | 1996-07-19T03:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpoints | List of EndpointEnvelopeV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| eventName | String | |||
| traceId | String | |||
| using | UsingList |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| accessStatuses | List of AppAccessStatus | |||
| description | String | |||
| discoverable | Boolean | |||
| entryPoint | String | |||
| mountDatasets | Boolean | |||
| name | String | |||
| projectId | String | |||
| renderIFrame | Boolean | |||
| version | AppVersionCreationRequest | |||
| visibility | String | AUTHENTICATED GRANT_BASED GRANT_BASED_STRICT PUBLIC |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | Number | |||
| id | String | |||
| resourceUsage | AppInstanceResourceUsageTimeseries | |||
| status | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| accessStatuses | List of AppAccessStatus | |||
| currentVersion | AppVersionResponse | |||
| description | String | |||
| discoverable | Boolean | |||
| entryPoint | String | |||
| id | String | |||
| mountDatasets | Boolean | |||
| name | String | |||
| project | AppProjectResponse | |||
| publisher | AppUserResponse | |||
| renderIFrame | Boolean | |||
| thumbnailEtag | String | |||
| updatedAt | Number | |||
| url | String | |||
| vanityUrl | String | |||
| views | Number | |||
| visibility | String | AUTHENTICATED GRANT_BASED GRANT_BASED_STRICT PUBLIC |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| accessStatuses | List of AppAccessStatus | |||
| currentVersion | AppVersionResponse | |||
| description | String | |||
| discoverable | Boolean | |||
| entryPoint | String | |||
| id | String | |||
| isPinned | Boolean | Whether this app is pinned by the current user | ||
| mountDatasets | Boolean | |||
| name | String | |||
| project | AppProjectResponse | |||
| publisher | AppUserResponse | |||
| renderIFrame | Boolean | |||
| thumbnailEtag | String | |||
| updatedAt | Number | |||
| url | String | |||
| vanityUrl | String | |||
| views | Number | |||
| visibility | String | AUTHENTICATED GRANT_BASED GRANT_BASED_STRICT PUBLIC |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| accessStatuses | List of AppAccessStatus | |||
| description | String | |||
| discoverable | Boolean | |||
| entryPoint | String | |||
| mountDatasets | Boolean | |||
| name | String | |||
| renderIFrame | Boolean | |||
| version | AppVersionCreationRequest | |||
| visibility | String | AUTHENTICATED GRANT_BASED GRANT_BASED_STRICT PUBLIC |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| autoscalingSpecification | AppAutoscalingSpecification | |||
| bundleId | String | |||
| dfsCommitId | String | |||
| environmentId | String | |||
| environmentRevisionId | String | |||
| externalVolumeMountIds | List of string | |||
| gitRef | GitRef | |||
| hardwareTierId | String | |||
| netAppVolumeIds | List of string | |||
| vanityUrl | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| autoscalingSpecification | AppAutoscalingSpecification | |||
| bundleId | String | |||
| bundleName | String | |||
| createdAt | Number | |||
| currentInstance | AppInstanceSummaryResponse | |||
| dfsCommitId | String | |||
| environmentId | String | |||
| environmentRevisionId | String | |||
| externalVolumeMountIds | List of string | |||
| gitRef | GitRef | |||
| hardwareTierId | String | |||
| id | String | |||
| netAppVolumeIds | List of string | |||
| publisher | AppUserResponse | |||
| updatedAt | Number | |||
| vanityUrl | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| count | Integer | |||
| timeseries | List of AppViewsTimeseries | |||
| users | Object | |||
| versions | List of object |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| action | Action | |||
| actor | Actor | |||
| affecting | Affecting | |||
| from | Entity | |||
| in | Entity | |||
| metadata | StringStringMap | |||
| targets | TargetList | |||
| timestamp | Integer | |||
| to | Entity |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| events | List of AuditEvent | |||
| total | Integer |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| domain | String | |||
| gitServiceProvider | GitServiceProviderV1 | |||
| name | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTag | BillingTagWithStatusV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTags | List of BillingTagV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| notifications | BillingTagsSettingNotificationsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| notifications | BillingTagsSettingNotificationsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 | |||
| notifications | BillingTagsSettingNotificationsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 | |||
| notifications | BillingTagsSettingNotificationsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CloudCostV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| amortizedCost | CloudCostDetailsV2 | |||
| amortizedNetCost | CloudCostDetailsV2 | |||
| invoicedCost | CloudCostDetailsV2 | |||
| key | CostKeyV2 | |||
| listCost | CloudCostDetailsV2 | |||
| netCost | CloudCostDetailsV2 | |||
| window | CostTimeWindowV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| clusterType | ClusterTypeV1 | |||
| computeEnvironmentId | String | Id of compute environment to use. | 623139857a0af0281c01a6a4 | |
| computeEnvironmentRevisionSpec | EnvironmentRevisionSpecV1 | |||
| masterHardwareTierId | String | Hardware tier to use for master node in compute cluster. | medium-k8s | |
| maxWorkerCount | Integer | Max number of workers to use in compute cluster. Enables auto-scaling for cluster when present. | 10 | |
| workerCount | Integer | Number of workers to use in compute cluster. Used as min number of workers in maxWorkerCount is set. | 4 | |
| workerHardwareTier | String | Hardware tier to use for workers in compute cluster. | large-k8s | |
| workerStorageMB | Number | Disk size in MB for each worker. | 5 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTag | BillingTagV1 | |||
| copyDatasets | Boolean | Whether to copy the Project's datasets or not | ||
| gitCodeRepoSpec | GitCodeRepoSpecV1 | |||
| importedGitReposCredentialId | String | The Domino ID of the PAT credential, which will be used to access the Imported Git Repos on the new project. | ||
| name | String | The name of the new Domino Project. | ||
| ownerId | String | The Domino ID of owner of the copied project. | ||
| visibility | ProjectVisibilityV1 | The visibility of the new Project. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| activation | CostActivationStatusV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAllocationV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAllocationV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAllocationSummaryV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAllocationSummaryV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| allocationProperties | CostPropertiesV2 | |||
| cpu | CostAllocationSummaryCpuV2 | |||
| end | String | |||
| externalCost | Number | |||
| gpu | CostAllocationSummaryGpuV2 | |||
| key | CostKeyV2 | |||
| labels | CostLabelsV2 | |||
| loadBalancer | CostAllocationSummaryLoadBalancerV2 | |||
| minutes | Number | |||
| network | CostAllocationSummaryNetworkV2 | |||
| pv | CostAllocationSummaryPvV2 | |||
| ram | CostAllocationSummaryRamV2 | |||
| sharedCost | Number | |||
| start | String | |||
| totalCost | Number | |||
| totalEfficiency | Number | |||
| window | CostTimeWindowV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| cpuCoreHours | Number | |||
| cpuCoreRequestAverage | Number | |||
| cpuCoreUsageAverage | Number | |||
| cpuCores | Number | |||
| cpuCost | Number | |||
| cpuCostAdjustment | Number | |||
| cpuEfficincy | Number | |||
| discount | Number | |||
| gpuCost | Number | |||
| gpuCostAdjustment | Number | |||
| gpuCount | Number | |||
| gpuHours | Number | |||
| labels | Object | |||
| loadBalancerCost | Number | |||
| loadBalancerCostAdjustment | Number | |||
| name | String | |||
| nodeType | String | |||
| pv | Object | |||
| ramCost | Number | |||
| ramCostAdjustment | Number | |||
| totalCost | Number | |||
| window | Object |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| allocationProperties | CostPropertiesV2 | |||
| cpu | CostAllocationCpuV2 | |||
| end | String | |||
| externalCost | Number | |||
| gpu | CostAllocationGpuV2 | |||
| key | CostKeyV2 | |||
| labels | CostLabelsV2 | |||
| loadBalancer | CostAllocationLoadBalancerV2 | |||
| minutes | Number | |||
| network | CostAllocationNetworkV2 | |||
| pv | CostAllocationPvV2 | |||
| ram | CostAllocationRamV2 | |||
| sharedCost | Number | |||
| start | String | |||
| totalCost | Number | |||
| totalEfficiency | Number | |||
| window | CostTimeWindowV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| breakdown | CostAssetsBreakdownV2 | |||
| count | Number | |||
| hours | Number | |||
| hoursUsed | Number | |||
| usageMax | Number |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| breakdown | CostAssetsBreakdownV2 | |||
| coreHours | Number | |||
| cores | Number | |||
| cost | Number |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAssetsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAssetsV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| breakdown | CostAssetsBreakdownV2 | |||
| byteHours | Number | |||
| bytes | Number | |||
| cost | Number |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| adjustment | Number | |||
| assetProperties | CostPropertiesV2 | |||
| assetType | String | |||
| byte | CostAssetsByteV2 | |||
| cpu | CostAssetsCpuV2 | |||
| discount | Number | |||
| end | String | |||
| gpu | CostAssetsGpuV2 | |||
| key | CostKeyV2 | |||
| labels | CostAssetsLabelsV2 | |||
| minutes | Number | |||
| overhead | CostAssetsOverheadV2 | |||
| preemptible | Number | |||
| ram | CostAssetsRamV2 | |||
| start | String | |||
| storage | CostAssetsStorageV2 | |||
| totalCost | Number | |||
| window | CostTimeWindowV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| definition | ProjectTemplateDefinition | |||
| isArchived | Boolean | |||
| isCompanyOfficial | Boolean | |||
| sourceProject | ProjectTemplateSourceProject |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataSourceId | String | ID of the Data Source | ||
| dataSourceName | String | name of the Data Source | ||
| dataSourceType | DataSourceTypeV1 | |||
| eventKind | DataSourceAuditEventKindV1 | |||
| metadata | DataSourceAuditMetadataV1 | |||
| performedBy | String | ID of user who performed the event | ||
| timestamp | String | timestamp of when event was performed | 1996-07-19T03:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| authType | DataSourceAuthTypeV1 | |||
| config | DataSourceConfigV1 | |||
| credentialType | DataSourceCredentialTypeV1 | |||
| dataSourceType | DataSourceTypeV1 | |||
| description | String | Description of the Data Source | My Data Source | |
| displayName | String | Data Source display name | Azure Data Lake Store | |
| id | String | ID of the Data Source | 62604702b7e5d347dbe7a909 | |
| lastUpdated | String | ISO 8601 formatted time of when the Data Source was last updated | 2022-04-23T18:25:43.511Z | |
| name | String | User given name of the Data Source | data-source-name | |
| ownerId | String | ID of the Data Source owner | 62604702b7e5d347dbe7a909 | |
| ownerUsername | String | Username of the owner of the Data Source | owner-username | |
| permissions | DataSourcePermissionsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | DataSourceConfigV1 | |||
| credentials | DataSourceCredentialsV1 | |||
| permissions | DataSourcePermissionsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the dataset was created | 2022-03-12T02:13:44.467Z | |
| description | String | A description of the dataset | ||
| id | String | Dataset ID | 62313ce67a0af0281c01a6a5 | |
| name | String | Name of the dataset | My Dataset | |
| projectId | String | ID of the project this dataset belongs to | 62313ce67a0af0281c01a6a5 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| containerPath | String | Location dataset is mounted at in the Job. | /domino/datasets/local/quick-start | |
| datasetName | String | Name of dataset to be mounted. | MyDataset | |
| id | String | Id of dataset to be mounted. | 623137f57a0af0281c01a6a0 | |
| isInput | Boolean | Whether a dataset was an input to be used in the execution, or an output created by the execution. | ||
| projectId | String | Id of project the dataset belongs to. | 6231383c7a0af0281c01a6a1 | |
| snapshotId | String | Id of snapshot to mount for this dataset. | 623138807a0af0281c01a6a2 | |
| snapshotVersion | Integer | Version of dataset snapshot to mound. | 2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasetInfo | DatasetInfoV1 | dataset not copied | ||
| errorMessage | String | error message explaining why dataset wasn't copied |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the dataset was created | 2022-03-12T02:13:44.467Z | |
| description | String | A description of the dataset | ||
| id | String | ID of the dataset | 62313ce67a0af0281c01a6a5 | |
| name | String | Name of the dataset | My Dataset | |
| projectId | String | ID of the project this dataset belongs to | 62313ce67a0af0281c01a6a5 | |
| snapshotIds | List of string | List of snapshot IDs belonging to this dataset | ||
| tags | DatasetRwTagsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | DatasetRwDetailsV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| grantDetails | List of DatasetRwGrantDetailsV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| isOrganization | Boolean | If target id is an organization | ||
| targetId | String | ID of the user within the grant | ||
| targetName | String | Username of user within the grant | ||
| targetRole | DatasetRwRoleV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| grants | List of DatasetRwGrantV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| targetId | String | ID of the user within the grant | ||
| targetRole | DatasetRwRoleV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | DatasetRwDetailsV1 | |||
| projectInfo | DatasetRwProjectInfoDtoV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| newRepoName | String | The name of the new repository. | ||
| newRepoOwnerName | String | The name of the user who will own the new repository in the git service provider. | ||
| visibility | ProviderRepoVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| success | Boolean |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Deployment Target following the schema in its Deployment Target Type | ||
| defaultResourceConfigurationId | String | The ID of the default resource configuration | ||
| deploymentTargetTypeId | String | ID of the Deployment Target Type this Deployment Target belongs to | ||
| deploymentTargetTypeName | String | Name of the Deployment Target Type this Deployment Target belongs to | ||
| id | String | UUID for the Deployment Target | ||
| isGloballyAccessible | Boolean | Whether or not the Deployment Target is globally accessible | ||
| lastModified | String | Timestamp of the last update to the deployment target (will be the creation timestamp on creation) | ||
| name | String | Internal name for the Deployment Target | Production | |
| resourceConfigurations | List of ResourceConfiguration | |||
| userAndOrganizationIds | List of string | User and Organization IDs that can use this Deployment Target |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultResourceConfigs | Object | |||
| resourceConfigSchema | JSONSchema | |||
| targetConfigSchema | JSONSchema |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataPlaneId | String | ID of the data plane where the operator is deployed | ||
| deploymentTargetConfigurationSchemas | DeploymentTargetConfigurationSchemas | |||
| id | String | UUID for the Deployment Target Type | ||
| logoUrl | String | Url to pull logo image from | ||
| modelDeploymentConfigurationSchemas | SharedAndModelSpecificSchemas | |||
| modelDeploymentCustomResourceDefinition | DeploymentCustomResourceDefinition | |||
| modelDeploymentStateSchemas | SharedAndModelSpecificSchemas | |||
| modelDeploymentSupportedModelSources | List of ModelSource | Model sources supported by Domino | ||
| modelDeploymentTypeConfigurationSchemas | DeploymentTypeSpecificSchemas | |||
| modelDeploymentTypeStateSchemas | DeploymentTypeSpecificSchemas | |||
| name | String | Internal name for the Deployment Target Type | aws | |
| operatorVersion | String | Version of the operator | 1.0.2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataPlaneId | String | ID of the data plane where the operator is deployed | ||
| deploymentTargetConfiguration | DeploymentTargetConfiguration | |||
| deploymentTargetLastModified | String | Timestamp of the last update to the deployment target (will be the creation timestamp on creation) | ||
| deploymentTargetTypeId | String | UUID for the Deployment Target Type | ||
| deploymentTargetTypeName | String | Internal name for the Deployment Target Type | aws | |
| deploymentTargetTypeOperatorVersion | String | Version of the operator | 1.0.2 | |
| modelDeploymentConfigurationSchemas | SharedAndModelSpecificSchemas | |||
| modelDeploymentCustomResourceDefinition | DeploymentCustomResourceDefinition | |||
| modelDeploymentStateSchemas | SharedAndModelSpecificSchemas | |||
| modelDeploymentSupportedModelSources | List of ModelSource | Model sources supported by Domino | ||
| modelDeploymentTypeConfigurationSchemas | DeploymentTypeSpecificSchemas | |||
| modelDeploymentTypeStateSchemas | DeploymentTypeSpecificSchemas | |||
| resourceConfigurationLastModified | String | Timestamp of the last update to the resource configuration (will be the creation timestamp on creation) |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| creationDate | String | ISO 8601 formatted time of when the Endpoint was created | 2022-04-23T18:25:43.511Z | |
| endpointId | String | ID of the endpoint | 62604702b7e5d347dbe7a909 | |
| endpointName | String | Valid name of the endpoint | completions | |
| endpointType | String | Type of the endpoint | llm/v1/completions | |
| modelConfig | ModelConfigV1 | |||
| modelName | String | Name of the model | gpt-4 | |
| modelProvider | String | Provider of the model | openai |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environment | EnvironmentV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Id of owner of an environment. | 6231327c7a0af0281c01a69b | |
| ownerType | EnvironmentOwnerTypeV1 | |||
| username | String | Username of owner of an environment. | OrgOwner |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environment | Environment | |||
| id | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environmentRevision | EnvironmentRevisionV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| availableTools | List of EnvironmentToolV1 | |||
| id | String | Id of Environment Revision. | 62313cfd7a0af0281c01a6a6 | |
| number | Integer | Revision number, increasing sequentially with each revision. | 4 | |
| status | EnvironmentRevisionBuildStatusV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| iconUrl | String | Url to pull icon image from | /assets/images/workspace-logos/Jupyter.svg | |
| name | String | Name of environment tool | Jupyter | |
| proxyConfig | ProxyConfigV1 | |||
| startScripts | List of string | |||
| supportedFileExtensions | List of string | |||
| title | String | Title of environment tool. | Jupyter |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| activeRevisionTags | List of string | The tags on the active revision for this environment | ||
| archived | Boolean | Whether the environment is archived | ||
| id | String | Id of environment | 623132867a0af0281c01a69c | |
| internalTags | List of string | The internal tags specifying if this environment is restricted | ||
| isCurated | Boolean | Whether or not the environment is curated for a deployment | ||
| latestRevision | EnvironmentRevisionV1 | |||
| name | String | MyOrg | ||
| owner | EnvironmentOwnerV1 | |||
| rebuildOnBaseChanges | EnvironmentRebuildOnBaseChangesV1 | |||
| restrictedRevision | EnvironmentRevisionV1 | |||
| selectedRevision | EnvironmentRevisionV1 | |||
| supportedClusters | List of ClusterTypeV1 | |||
| visibility | EnvironmentVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mountPath | String | Path to mount the external volume at. | /path/to/my/volume | |
| name | String | Name of external volume to mount. | MyExternalVolume | |
| readOnly | Boolean | Whether to mount the volume as read only. | ||
| subPath | String | Path within the external volume to mount. The entire volume will be mounted if not specified. | /mypath |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| fieldName | String | |||
| fieldType | FieldType |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentialId | String | The Domino ID of the PAT credential, which will be used to copy and/or read from the code repository on the new project. | ||
| deepCopy | DeepCopyGitRepoSpecV1 | |||
| importFilesTarget | ImportFilesRepoTargetV1 | |||
| referenceCopy | ReferenceCopyGitRepoSpecV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credential | GitCredentialsAccessorV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| domain | String | The domain these credentials apply to | github.com | |
| fingerprint | String | ba:78:09:d8:4b:3b:09:9b:43:bf:9b:5a:34:f7:3f:28 | ||
| gitServiceProvider | GitServiceProviderV1 | |||
| id | String | Id for these git credentials | ||
| name | String | Name for these git credentials | My creds | |
| protocol | String | https |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goal | LinkedGoalV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| availableCapacityWithoutLaunching | Integer | |||
| capacityLevel | String | CanExecuteWithCurrentInstances RequiresLaunchingInstance Full Unknown | ||
| executingRuns | Integer | |||
| maxAvailableCapacity | Integer | |||
| maxConcurrentRuns | Integer | |||
| maxNumberOfExecutors | Integer | |||
| numberOfExecutors | Integer | |||
| queuedRuns | Integer |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| hardwareTier | HardwareTierV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| allowSharedMemoryToExceedDefault | Boolean | |||
| cores | Number | 1 | ||
| coresLimit | Number | |||
| memory | InformationV1 | |||
| memoryLimit | InformationV1 | |||
| memorySwapLimit | InformationV1 | |||
| sharedMemoryLimit | InformationV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataPlaneId | String | Unique identifier for the data plane owning the hardware tier | 62313ce67a0af0281c01a6a5 | |
| dataPlaneName | String | Name of the data plane owning the hardware tier | My Data Plane | |
| id | String | Unique identifier for the hardware tier | 62313ce67a0af0281c01a6a5 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| availabilityZones | List of string | |||
| capacity | HardwareTierCapacityV1 | |||
| centsPerMinute | Number | Cost per minute of using this hardware tier as defined by an Admin. | ||
| computeClusterRestrictions | HardwareTierComputeClusterRestrictionsV1 | |||
| creationTime | String | When the hardware tier was created | 2022-03-12T02:13:44.467Z | |
| dataPlaneId | String | |||
| flags | HardwareTierFlagsV1 | |||
| gpuConfiguration | HardwareTierGpuConfigurationV1 | |||
| id | String | small-k8s | ||
| maxSimultaneousExecutions | Integer | |||
| metadata | Object | |||
| name | String | My-HardwareTier | ||
| nodePool | String | |||
| overProvisioning | HardwareTierOverProvisioningV1 | |||
| podCustomization | HardwareTierPodCustomizationV1 | |||
| resources | HardwareTierResourcesV1 | |||
| tags | List of string | |||
| updateTime | String | When the hardwareTier was last updated | 2022-03-12T02:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| huggingFaceToken | String | Optional Hugging Face token for private models | hf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | |
| modelId | String | Hugging Face model ID | microsoft/DialoGPT-medium | |
| modelRevision | String | Optional model revision | fe8a4ea1ffedaf415f4da2f062534de366a451e6 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| apiToken | String | The API token for the model | 62313ce67a0af0281c01a6a5 | |
| commit | String | The commit of the model | 62313ce67a0af0281c01a6a5 | |
| modelType | ModelTypeV1 | |||
| path | String | The path to the model | my-model |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| additionalProperties | JSONSchema | |||
| default | ||||
| description | String | |||
| enum | Array | |||
| format | String | Superset of valid JSON Schema and OpenAPI formats. | date-time time date duration email idn-email hostname idn-hostname ipv4 ipv6 uuid uri uri-reference iri iri-reference uri-template json-pointer relative-json-pointer regex float double int32 int64 password byte binary multiline password-multiline | |
| id | String | |||
| items | JSONSchema | |||
| maxItems | PositiveInteger | |||
| maxLength | PositiveInteger | |||
| maxProperties | PositiveInteger | |||
| maximum | Number | |||
| minItems | PositiveIntegerDefault0 | |||
| minLength | PositiveIntegerDefault0 | |||
| minProperties | PositiveIntegerDefault0 | |||
| minimum | Number | |||
| pattern | String | |||
| properties | Object | |||
| required | StringArray | |||
| title | String | |||
| type | JSONSchemaType | |||
| uniqueItems | Boolean |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commentsCount | Integer | |||
| commitDetails | CommitDetailsV1 | |||
| computeCluster | ComputeClusterConfigV1 | |||
| datasetMounts | List of DatasetMountV1 | |||
| dominoStats | List of DominoStatsV1 | |||
| externalVolumeMounts | List of ExternalVolumeMountV1 | |||
| gitRepos | List of MountedGitRepoV1 | |||
| goalIds | List of string | |||
| id | String | |||
| mainRepoGitRef | GitRefV1 | |||
| netAppVolumeMounts | List of NetAppVolumeMountV1 | |||
| number | Integer | |||
| projects | List of MountedProjectV1 | |||
| queuedJobStatusDetails | QueuedJobStatusDetailsV1 | |||
| runCommand | String | |||
| runLauncherId | String | |||
| stageTimes | StageTimesV1 | |||
| startedById | String | |||
| status | JobStatusV1 | |||
| tags | List of TagV1 | |||
| title | String | |||
| usage | JobUsageV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| job | JobDetailsV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| helpLink | String | Suggestion link for helpful resources. | Error. No such file or directory. | |
| isComplete | Boolean | Whether all logs for the job have been retrieved. | ||
| logContent | List of LogContentV1 | |||
| problem | String | Description of issue that occurred in a job. | python: can't open file 'invalid.py': [Errno 2] No such file or directory |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commitDetails | CommitDetailsV1 | |||
| computeCluster | ComputeClusterConfigV1 | |||
| datasetMounts | List of DatasetMountV1 | |||
| dominoStats | List of DominoStatsV1 | |||
| externalVolumeMounts | List of ExternalVolumeMountV1 | |||
| gitRepos | List of MountedGitRepoV1 | |||
| id | String | |||
| mainRepoGitRef | GitRefV1 | |||
| netAppVolumeMounts | List of NetAppVolumeMountV1 | |||
| number | Integer | |||
| projects | List of MountedProjectV1 | |||
| runCommand | String | |||
| runLauncherId | String | |||
| stageTimes | StageTimesV1 | |||
| startedById | String | |||
| status | JobStatusV1 | |||
| title | String | |||
| usage | JobUsageV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currentStage | String | The stage this goal is currently assigned. | Ideation | |
| description | String | Description of the Goal. | Develop a better performing model | |
| goalId | String | Id of Goal linked to Job. | 62313cfd7a0af0281c01a6a6 | |
| jobId | String | Id of Job linked to Goal. | 62313d207a0af0281c01a6a7 | |
| projectId | String | Id of project resources belong to. | 62313d377a0af0281c01a6a8 | |
| title | String | Name of goal. | MyGoal |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of AppInstanceSummaryResponse | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of AppVersionResponse | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of AppSummaryResponse | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| log | String | Log message | Pulling image "172.20.22.242:5000/noahjax11699-compute/environment:622a6879dde1a920fcccfef5-1" | |
| logType | LogTypeV1 | |||
| size | Integer | Length of log line. | 94 | |
| timestamp | String | Time logs were written. | 2022-03-12T02:13:51.616Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| logs | JobLogsV1 | |||
| metadata | Object |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | Optional text to append to the metric alert message | ||
| metric | String | Name of the metric to send alert for | ||
| modelMonitoringId | String | ID of the monitored model to send metric alerts for | ||
| targetRange | TargetRangeV1 | |||
| value | Number | Value of the metric |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| referenceTimestamp | String | Timestamp associated with the metric log entry | ||
| tags | List of MetricTagV1 | List of tags associated with the metric | ||
| value | Number | Value of the metric |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| metricValues | List of MetricValueV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| access | ModelApiAccessConfiguration | |||
| activeVersion | ModelApiVersionSummary | |||
| bundleId | String | The ID of the bundle governing the model API to create. | ||
| collaborators | List of ModelApiCollaboratorRole | The collaborators of the Model API. | ||
| description | String | The description of the Model API. | ||
| environmentId | String | The id of the environment the Model API is deployed to. | ||
| hardwareTierId | String | The id of the hardware tier the Model API is deployed with. | ||
| healthCheck | ModelApiHealthCheckConfiguration | |||
| id | String | The id of the Model API. | ||
| isArchived | Boolean | Whether the Model API is archived. | ||
| isAsync | Boolean | Whether the Model API is async. | ||
| metadata | ModelApiMetadata | |||
| name | String | The name of the Model API. | ||
| overrideRequestTimeoutSecs | Integer | The request timeout configuration of the Model API. | ||
| replicas | Integer | The number of replicas of the Model API. | ||
| resourceQuotaId | String | The id of the resource quota the Model API is deployed with. | ||
| routingMode | String | The routing mode of the Model API. | ||
| strictNodeAntiAffinity | Boolean | Whether the Model API has strict node anti affinity. | ||
| volumes | List of ModelApiVolume | The volumes of the Model API. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| accessTokens | List of ModelApiAccessToken | The access tokens of the Model API. | ||
| isPublic | Boolean | Whether the Model API is public. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| created | Number | The creation date for the access token. | ||
| createdBy | String | The id of the user that created the access token. | ||
| id | String | The id of the access token. | ||
| lastGenerated | Number | The date the access token was last generated. | ||
| lastGeneratedBy | String | The id of the user that last generated the access token. | ||
| name | String | The name of the access token. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| bundleId | String | The ID of the bundle governing the model API to create. | ||
| description | String | The description of the Model API to create. | ||
| environmentId | String | The id of the environment the Model API to create should be deployed to. | ||
| environmentVariables | List of ModelApiEnvironmentVariable | The environment variables of the Model API to create. | ||
| hardwareTierId | String | The id of the hardware tier the Model API to create should be deployed with. | ||
| isAsync | Boolean | Whether the Model API to create should be async. | ||
| name | String | The name of the Model API to create. | ||
| replicas | Integer | The number of replicas of the Model API should be created with. | ||
| resourceQuotaId | String | The id of the resource quota the Model API to create should be deployed with. | ||
| strictNodeAntiAffinity | Boolean | Whether the Model API to create should have strict node anti affinity. | ||
| version | ModelApiVersionCreationRequest |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| failureThreshold | Integer | The threshold of health check failures for the Model API. | ||
| initialDelaySeconds | Integer | The initial delay of the health check for the Model API. | ||
| periodSeconds | Integer | The health check period for the Model API. | ||
| timeoutSeconds | Integer | The health check timeout for the Model API. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of ModelApi | The Model APIs in the paginated list. | ||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| excludeFiles | List of string | The files excluded from the Model API. | ||
| file | String | The name of the source file of the model served by the Model API. | ||
| function | String | The function used to call the model served by the Model API. | ||
| registeredModelName | String | The name of the registered model served by the Model API. | ||
| registeredModelVersion | Integer | The version of the registered model served by the Model API. | ||
| type | String | The type of source of the Model API. | File Registry |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | The new description for the Model API. | ||
| environmentId | String | The id of the new environment to deploy the Model API with. | ||
| hardwareTierId | String | The id of the new hardware tier to deploy the Model API with. | ||
| name | String | The new name for the Model API. | ||
| replicas | Integer | The new number of replicas of the Model API. | ||
| resourceQuotaId | String | The id of the new resource quota to deploy the Model API with. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| bundleId | String | The ID of the bundle governing the model API to create. | ||
| commitId | String | The id of the commit of the Model API Version. | ||
| dataPlaneId | String | The id of the data plane the Model API Version is deployed to. | ||
| deployment | ModelApiVersionDeployment | |||
| description | String | The description of the Model API Version. | ||
| environmentRevisionId | String | The id of the environment revision the Model API Version is deployed on. | ||
| id | String | The id of the Model API Version. | ||
| labels | List of string | The labels of the Model API Version. | ||
| logHttpRequestResponse | Boolean | Whether the Model API Version should log the HTTP requests and responses. | ||
| metadata | ModelApiVersionMetadata | |||
| modelApiId | String | The id of the Model API the version belongs to. | ||
| monitoringEnabled | Boolean | Whether monitoring is enabled for the Mode API Version. | ||
| number | Integer | The version number of the Model API Version. | ||
| predictionDatasetResourceId | String | The id of the prediction dataset used by the Model API Version. | ||
| projectId | String | The id of the project the Model API Version belongs to. | ||
| provenanceCheckpointId | String | The id of the provenance checkpoint of the Model API Version. | ||
| recordInvocation | Boolean | Whether the Model API Version should record invocations. | ||
| source | ModelApiSource |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| buildId | String | The id of the build of the Model API Version | ||
| logs | List of ModelApiVersionLogLine | The build logs. | ||
| modelId | String | The id of the Model API | ||
| modelVersionId | String | The id of the Model API Version | ||
| sinceTimeNano | String | The start date of the logs. | ||
| status | String | The status of the build. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commitId | String | The id of the commit id of the Model API Version to create. | ||
| description | String | The description for the Model API Version to create. | ||
| environmentId | String | The id of the environment to deploy the Model API Version with. | ||
| logHttpRequestResponse | Boolean | Whether the Model API Version to create should log HTTP requests and responses. | ||
| monitoringEnabled | Boolean | Whether the Model API Version to create should have monitoring enabled. | ||
| predictionDatasetResourceId | String | The id of the prediction dataset to be used by the Model API Version to create. | ||
| projectId | String | The id of the project the Model API Version to create should belong to. | ||
| provenanceCheckpointId | String | The id of the provenance checkpoint of the Model API Version to create. | ||
| recordInvocation | Boolean | Whether the Model API Version to create should record invocations. | ||
| shouldDeploy | Boolean | Whether the Model API Version to create should be deployed. | ||
| source | ModelApiSource |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| logs | List of ModelApiVersionLogLine | The deployment logs. | ||
| status | String | The status of the deployment. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| logs | List of ModelApiVersionLogLine | The export logs. | ||
| modelId | String | The id of the Model API | ||
| modelVersionId | String | The id of the Model API Version | ||
| sinceTimeNano | String | The start date of the logs. | ||
| status | String | The status of the export. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| containerName | String | The name of the container the Model API Version is deployed to. | ||
| logs | List of ModelApiVersionLogLine | The instance logs. | ||
| maxResults | Integer | The maximum number of logs to retrieve | ||
| modelId | String | The id of the Model API | ||
| modelVersionId | String | The id of the Model API Version | ||
| podName | String | The name of the pod the Model API Version is deployed to. | ||
| sinceTimeNano | String | The start date of the logs. | ||
| tail | Boolean | Whether to fetch from tail or not |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| log | String | The content of the log line. | ||
| streamType | String | The type of stream the log line is sourced from. | ||
| tags | List of ModelApiVersionLogTag | The tags of the log line. | ||
| timeNano | Number | The time in nanoseconds of the log line. | ||
| timestamp | Number | The timestamp of the log line. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataPlaneId | String | The id of the data plane the Model API Version is deployed to. | ||
| deployment | ModelApiVersionDeployment | |||
| id | String | The id of the Model API Version. | ||
| number | Integer | The version number of the Model API Version. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborators | List of ModelDeploymentCollaborator | List of collaborators, if any | ||
| configuration | ModelDeploymentConfiguration | |||
| creationTimestamp | String | 2023-07-15T14:35:47.89Z | ||
| creatorInfo | CreatorInfo | |||
| deploymentTargetInfo | DeploymentTargetInfo | |||
| description | String | This endpoint is designed to provide businesses with insights into their customer retention patterns. | ||
| id | String | The id of the Model Deployment. | 614e40a7-0509-4cae-89af-55e2097b817d | |
| isGloballyAccessible | Boolean | Whether the Model Deployment is viewable by Domino Users who are not collaborators | ||
| models | List of ModelDetail | Models associated with this Model Deployment. | ||
| name | String | Income Classifier Deployment | ||
| remoteUpdateTimestamp | String | 2023-07-16T19:20:30.45Z | ||
| resourceConfigurationInfo | ResourceConfigurationInfo | |||
| status | ModelDeploymentStatus | |||
| version | Integer | 23 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials | Object | The actual credentials represented as key value pairs | ||
| credentialsType | CredentialsType | |||
| expirationTime | String | 2023-07-15T14:35:47.89Z | ||
| operationType | String | INVOKE_ENDPOINT |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of ModelDeploymentCredentials | The Model Deployments Credentials in the list |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| log | String | The content of the log line. | ||
| streamType | String | The type of stream the log line is sourced from. | ||
| tags | List of ModelDeploymentLogTag | The tags of the log line. | ||
| timeNano | String | The time in nanoseconds of the log line. | ||
| timestamp | String | The timestamp of the log line. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of ModelDeployment | The Model Deployments in the paginated list. | ||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| message | String | Message indicating error or other status information about the most recent operation. This field is required in this location for Domino model deployment schemas. | ||
| modelOperations | Object | Model-specific operations supported by this model deployment. This field is required with this structure in this location for Domino model deployment schemas. | ||
| modelStates | Object | The model-specific states | ||
| sharedOperations | List of ModelDeploymentStatusOperation | Operations supported by this model deployment. This field is required with this structure in this location for Domino model deployment schemas. | ||
| sharedState | Object | The state shared by all models in the deployment | ||
| state | String | Standard Domino state value. This field is required in this location for Domino model deployment schemas. | STARTING RUNNING UPDATING STOPPING STOPPED FAILED DELETING DELETED |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials | Object | |||
| examplePayload | String | |||
| examples | List of object | |||
| fields | Object | |||
| metadata | Object | This field provides metadata needed for an API user to invoke the operation. | ||
| type | String | This field provides identifiers for the operations supported by this type of model deployment. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environmentId | String | The id of the Domino environment. | ||
| environmentName | String | The name of the Domino environment. | ||
| name | String | XYZ Model | ||
| projectId | String | The id of the Domino project the source belongs to. | ||
| source | ModelDetailSource |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| registeredModelName | String | The name of the registered model served by this source. | Growth Forecasting Model | |
| registeredModelType | String | The type of this model source. | MODELREGISTRY MODELREGISTRY | |
| registeredModelVersion | Integer | The version of the registered model served by this source. | 3 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| maxNumberOfSequences | Integer | The maximum number of sequences (requests) processed in parallel | 256 | |
| servedModelName | String | The name used when calling the endpoint | my-model | |
| tensorParallelism | Integer | The number of GPUs used to split the model for faster inference | 1 | |
| vllmArguments | String | The arguments passed to the vLLM binary | --max-model-length 4095 --gpu-memory-utilization 0.90 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | ModelEndpointConfigurationV1 | |||
| description | String | The description of the endpoint | My Endpoint Description | |
| environment | EnvironmentUpdateV1 | |||
| hardwareTierId | String | The hardware tier ID of the endpoint | 62313ce67a0af0281c01a6a5 | |
| instructions | String | The instructions for using the endpoint | Use the endpoint to generate text | |
| modelSource | ModelSourceV1 | |||
| name | String | The name of the endpoint | My Endpoint | |
| versionDescription | String | The description of the initial version of the endpoint | My Endpoint Version Description | |
| versionLabel | String | The label of the initial version of the endpoint | 1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | The time the endpoint was created | 2022-03-12T02:13:44.467Z | |
| creator | ModelEndpointUserV1 | |||
| currentVersion | ModelEndpointVersionV1 | |||
| description | String | The description of the endpoint | My Endpoint Description | |
| id | String | The ID of the endpoint | 62313ce67a0af0281c01a6a5 | |
| instructions | String | The instructions for using the endpoint | Use the endpoint to generate text | |
| name | String | The name of the endpoint | My Endpoint | |
| projectId | String | The ID of the project that the endpoint belongs to | 62313ce67a0af0281c01a6a5 | |
| requestCount | Integer | The number of requests processed by the endpoint | 100 | |
| updatedAt | String | The last time the endpoint was modified | 2022-03-12T02:13:44.467Z | |
| url | String | The URL of the endpoint | https://my-endpoint.com |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | ModelEndpointConfigurationV1 | |||
| createdAt | String | The time the endpoint was created | 2022-03-12T02:13:44.467Z | |
| creator | ModelEndpointUserV1 | |||
| description | String | The description of the endpoint version | My Endpoint Version Description | |
| endpointId | String | The ID of the endpoint | 62313ce67a0af0281c01a6a5 | |
| environment | EnvironmentSummaryV1 | |||
| hardwareTier | HardwareTierSummaryV1 | |||
| label | String | The label of the endpoint version | 1 | |
| modelSource | ModelSourceV1 | |||
| number | Integer | The version number of the endpoint | 1 | |
| status | ModelEndpointStatusV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| huggingFaceSource | HuggingFaceModelSource | Hugging Face specific source details (required when sourceType is 'huggingface') | ||
| mlflowSource | MlflowModelSource | MLflow specific source details (required when sourceType is 'mlflow') | ||
| sourceType | String | Type of model source | huggingface mlflow huggingface |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| huggingFace | HuggingFaceModelSourceV1 | |||
| registeredModel | RegisteredModelSourceV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endingBranch | String | Branch this git repo ended at. | final-branch | |
| endingCommitId | String | Ending commitId for this git repo. | dff155c9a736f9cd230eac420e3c1ef3daa0ad7e | |
| id | String | Id of the git repo mounted to the Job. | 6231365e7a0af0281c01a69f | |
| name | String | Name of the git repo mounted to the Job. | MyRepo | |
| ref | String | |||
| serviceProvider | GitServiceProviderV1 | |||
| startingBranch | String | Branch this git repo started at. | init-test-branch | |
| startingCommitId | String | CommitId the git repo should be mounted at. | 4f2d5c2f54db4fbb16a093d4fb11fdb1fe0794c7 | |
| uri | String | Uri for the repo being mounted. | git@github.com:apache/spark.git |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| name | String | Name of Domino NetApp Volume to mount. | MyVolume | |
| snapshotMountPath | String | Path to mount the Snapshot directory of the Volume at. | /path/to/my/snapshot | |
| snapshotReadOnly | Boolean | Whether to mount the Snapshot directory as read only. | ||
| snapshotSubPath | String | Path within the Snapshot directory to mount. The entire Snapshot directory will be mounted if not specified. | /my/snapshot/subPath | |
| volumeMountPath | String | Path to mount the Domino NetApp Volume at. | /path/to/my/volume | |
| volumeReadOnly | Boolean | Whether to mount the Volume as read only. | ||
| volumeSubPath | String | Path within the Domino NetApp Volume to mount. The entire Volume will be mounted if not specified. | /my/volume/subPath |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| access | ProjectTemplateAccess | |||
| billingTag | BillingTagV1 | |||
| definition | NewProjectTemplateDefinition | |||
| description | String | |||
| name | String | |||
| sourceProject | NewProjectTemplateSourceProject |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| authType | DataSourceAuthTypeV1 | |||
| config | DataSourceConfigV1 | |||
| credentialType | DataSourceCredentialTypeV1 | |||
| credentials | DataSourceCredentialsV1 | |||
| dataSourceType | DataSourceTypeV1 | |||
| description | String | Description of the Data Source | My Data Source | |
| name | String | User given name of the Data Source | data-source-name | |
| permissions | DataSourcePermissionsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | Description of the dataset | ||
| grants | List of DatasetRwGrantV1 | Permission grants to be assigned for this newly created dataset. Note that permissions can be edited after creation. If snapshotId is passed in, this parameter won't have any effect and caller will be assigned dataset Ownership. | ||
| name | String | Name of this dataset. The name must be unique in the same project | ||
| projectId | String | ID of the project this dataset belongs to. Either projectId or snapshotId must be provided | ||
| snapshotId | String | ID of an existing snapshot to create a new dataset from. Either snapshotId or projectId must be provided. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Deployment Target following the schema in its Deployment Target Type | ||
| deploymentTargetTypeId | String | ID of the Deployment Target Type this Deployment Target belongs to | ||
| isGloballyAccessible | Boolean | Whether or not the Deployment Target is globally accessible | ||
| name | String | Internal name for the Deployment Target | Production | |
| resourceConfigurations | List of NewResourceConfiguration | |||
| userAndOrganizationIds | List of string | User and Organization IDs that can use this Deployment Target |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpointName | String | Valid name of the endpoint | completions | |
| endpointPermissions | EndpointPermissionsDtoV1 | |||
| endpointType | String | Type of the endpoint | llm/v1/completions | |
| modelConfig | ModelConfigV1 | |||
| modelName | String | Name of the model | gpt-4 | |
| modelProvider | String | Provider of the model | openai |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dockerfileInstructions | String | |||
| environmentVariables | List of EnvironmentVariableV1 | |||
| image | String | Environment revision image. Required for creating a new environment | ||
| postRunScript | String | |||
| postSetupScript | String | |||
| preRunScript | String | |||
| preSetupScript | String | |||
| skipCache | Boolean | |||
| summary | String | |||
| supportedClusters | List of ClusterTypeV1 | |||
| tags | List of string | |||
| useVpn | Boolean | |||
| workspaceTools | List of EnvironmentToolV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| addBaseDependencies | Boolean | Required for creating a new environment | ||
| description | String | |||
| duplicateFromEnvironmentId | String | The id of the environment to duplicate. When specifying this property, no other properties in the payload must be set. | ||
| isCurated | Boolean | |||
| isRestricted | Boolean | Specifies if an environment is restricted. Only users with ClassifyEnvironments permission can set this to true | ||
| name | String | Environment name. Required for creating a new environment | ||
| orgOwnerId | String | Sets an Organization as the Environment owner. Only used if visibility is 'Private', as 'Global' environments don't have owners. | ||
| rebuildOnBaseChanges | EnvironmentRebuildOnBaseChangesV1 | |||
| visibility | NewEnvironmentVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| availabilityZones | List of string | |||
| centsPerMinute | Number | Cost per minute of using this hardware tier as defined by an Admin. | ||
| computeClusterRestrictions | HardwareTierComputeClusterRestrictionsV1 | |||
| dataPlaneId | String | |||
| flags | NewHardwareTierFlagsV1 | |||
| gpuConfiguration | HardwareTierGpuConfigurationV1 | |||
| id | String | small-k8s | ||
| maxSimultaneousExecutions | Integer | |||
| name | String | My-HardwareTier | ||
| nodePool | String | |||
| overProvisioning | HardwareTierOverProvisioningV1 | |||
| podCustomization | HardwareTierPodCustomizationV1 | |||
| resources | HardwareTierResourcesV1 | |||
| tags | List of string |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| commitId | String | Git commitId to start job from. Defaults to head commitId for the project. | 960a4c99a4cc38194cbacbcce41caa68ba5369ea | |
| computeCluster | ComputeClusterConfigV1 | |||
| environmentId | String | Id of environment to use when creating job. Defaults to project default environment. | 623131507a0af0281c01a699 | |
| environmentRevisionSpec | EnvironmentRevisionSpecV1 | |||
| externalVolumeMountIds | List of string | Ids of external volumes to be mounted on this job. | ||
| hardwareTier | String | Hardware tier to use for this job. Defaults to project default hardware tier. | small-k8s | |
| mainRepoGitRef | GitRefV1 | |||
| netAppVolumeIds | List of string | Ids of NetApp volumes to be mounted on this job. | ||
| projectId | String | Id of project to create job in. | 623130ad7a0af0281c01a698 | |
| runCommand | String | Command for job to run | main.py | |
| snapshotDatasetsOnCompletion | Boolean | Whether to snapshot datasets mounted on the Job when the Job completes. | ||
| snapshotNetAppVolumesOnCompletion | Boolean | Whether to snapshot NetApp volumes mounted on the Job when the Job completes. | ||
| title | String | Name of job to start | K-means clustering |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metric | String | Name of the metric to log values for | ||
| modelMonitoringId | String | ID of the monitored model to log metric values for | ||
| referenceTimestamp | String | Timestamp to associate the metric log entry with. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | ||
| tags | List of MetricTagV1 | List of tags associated with the metric | ||
| value | Number | Value of the metric |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| newMetricValues | List of NewMetricValueV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborators | List of ModelDeploymentCollaborator | List of collaborators, if any. Will default to empty list if not provided | ||
| configuration | ModelDeploymentConfiguration | |||
| deploymentTargetId | String | ABC-123 | ||
| description | String | This endpoint is designed to provide businesses with insights into their customer retention patterns. | ||
| isGloballyAccessible | Boolean | Whether the Model Deployment is viewable by Domino Users who are not collaborators. Will default to false if not provided | ||
| models | List of NewOrUpdatedModelDetail | A list of models associated with this Model Deployment. | ||
| name | String | The Model Deployment name. | Income Classifier Deployment | |
| resourceConfigurationId | String | DEF-123 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | ModelEndpointConfigurationV1 | |||
| description | String | The description of the endpoint | My Endpoint Description | |
| environment | NewEnvironmentInfoV1 | |||
| hardwareTierId | String | The hardware tier ID of the endpoint | 62313ce67a0af0281c01a6a5 | |
| modelSource | ModelSourceV1 | |||
| name | String | The name of the endpoint | My Endpoint | |
| projectId | String | The project ID of the endpoint | 62313ce67a0af0281c01a6a5 | |
| vanityUrl | String | The optional Vanity URL of the endpoint | my-endpoint/v1 | |
| versionDescription | String | The description of the initial version of the endpoint | My Endpoint Version Description | |
| versionLabel | String | The label of the initial version of the endpoint | 1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| huggingFace | HuggingFaceModelSourceV1 | |||
| registeredModel | RegisteredModelSourceV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environmentId | String | The id of the Domino environment. | ||
| name | String | XYZ Model | ||
| source | ModelDetailSource |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Resource Configuration following the schema in its Deployment Target Type | ||
| description | String | Description for the Resource Configuration | ||
| id | String | UUID for the Resource Configuration. Must be included if updating an existing Resource Configuration. If missing, a new Resource Configuration is created. | ||
| isDefault | Boolean | Whether the resource configuration is the default one | ||
| name | String | Internal name for the Resource Configuration | gpu_large |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| members | List of OrganizationMemberV1 | |||
| name | String | The name for this organization | MyNewOrg |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultRef | ProjectRepositoryReferenceV1 | |||
| gitCredentialId | String | Id of the git creds to use for the repo. Credentials only apply for the current user, and other users will need to add their own unique creds. | ||
| name | String | Optional name of the repository in the project | ||
| serviceProvider | GitServiceProviderV1 | |||
| uri | String | URI of the repository origin | https://github.com/torvalds/linux |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| computeClusterEnvironmentRevision | NewEnvironmentRevision | |||
| defaultEnvironmentRevision | NewEnvironmentRevision | |||
| defaultHardwareTier | NewHardwareTier |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| settings | NewProjectSettings |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| gitProviderCodeSpec | TemplateBackingGitCodeSpec | |||
| id | String | |||
| included |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTag | BillingTagV1 | |||
| description | String | Project description. | ||
| isRestricted | Boolean | Optional flag for setting a new project as restricted. ProjectClassifier permission required for use. | ||
| mainRepository | NewProjectGitRepositoryV1 | |||
| name | String | Name of this project. The name must be unique and cannot contain white space. | ||
| ownerId | String | Optional Id of a user to own this project. Defaults to the calling user if not provided. Does not currently support creating projects owned by Organizations. | ||
| repoToCreate | RepoToCreateV1 | |||
| templateDetails | ProjectTemplateDetailsV1 | |||
| visibility | ProjectVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTag | BillingTagV1 | |||
| description | String | Project description. | ||
| isRestricted | Boolean | Optional flag for setting a new project as restricted. ProjectClassifier permission required for use. | ||
| mainRepository | NewProjectGitRepositoryV1 | |||
| name | String | Name of this project. The name must be unique and cannot contain white space. | ||
| ownerId | String | Optional Id of a user to own this project. Defaults to the calling user if not provided. Does not currently support creating projects owned by Organizations. | ||
| repoToCreate | RepoToCreateV2 | |||
| templateDetails | ProjectTemplateDetailsV1 | |||
| visibility | ProjectVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| description | String | The description of the registered model | This model predicts housing prices | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. | ||
| experimentRunId | String | The id of the experiment run to create the version from | a8ea375c781d4b9c8e58469f0ad738f8 | |
| modelName | String | The name of the registered model | housing_price_predictor | |
| tags | RegisteredModelTagsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| create | Boolean | Indicates whether to create or update the registered model | ||
| description | String | Optional description of the registered model | Customer churn prediction model trained on historical data | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. | ||
| modelCategory | String | Category of the model (e.g., "genai", "ml") | genai | |
| modelName | String | The name of the registered model | churn-prediction-model | |
| modelSource | ModelSource | |||
| modelType | String | Type of the model (e.g., "llm", "embedding", "other", "ml") | llm | |
| projectId | String | Project ID of the registered model. Required for Hugging Face models only. For MLflow models, this is ignored as the project is determined from the experiment run id. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| artifact | String | The artifact of the run to create the version from | LogisticRegression | |
| description | String | The description of the registered model version | Logistic regression model version 2 | |
| experimentRunId | String | The id of the experiment run to create the version from | a8ea375c781d4b9c8e58469f0ad738f8 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Resource Configuration following the schema in its Deployment Target Type | ||
| deploymentTargetId | String | ID of the Deployment Target this Resource Configuration belongs to | ||
| description | String | Description for the Resource Configuration | ||
| isDefault | Boolean | Whether the resource configuration is the default one | ||
| name | String | Internal name for the Resource Configuration | gpu_large |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| org | OrganizationV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| organizationRole | OrganizationRoleV1 | |||
| userId | String | Id of the user in the org. | 6234c9542bc6731e3471ade8 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultEnvironmentId | String | Id of the default environment used in the organization. | 6231327c7a0af0281c01a65f | |
| id | String | Organization identifier in the users collection. | 623132867a0af0281c01a69c | |
| members | List of OrganizationMemberV1 | List of the organization members. | ||
| name | String | Organization name. | MyOrg |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of ProjectTemplate | |||
| paginationDetails | PaginationFilterV1 | |||
| totalCount | Integer |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataSources | List of DataSourceEnvelopeV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasets | List of DatasetRwDetailsV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasets | List of DatasetRwInfoDtoV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of DeploymentTarget | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environments | List of EnvironmentV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials | List of GitCredentialsAccessorV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| repositories | List of ProjectGitRepositoryV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goals | List of LinkedGoalV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| hardwareTiers | List of HardwareTierV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| jobs | List of JobV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of ModelEndpointV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| orgs | List of OrganizationV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| projects | List of ProjectV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of string | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelVersionModelApiV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelVersionOverviewV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelVersionOverviewV2 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelV1 | |||
| metadata | TokenPaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of RegisteredModelForUIV1 | |||
| metadata | TokenPaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| items | List of ResourceConfiguration | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| serviceAccounts | List of ServiceAccount |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials | List of GitCredentialsAccessorV1 | |||
| metadata | PaginatedMetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| tokens | List of ServiceAccountTokenDetails |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| snapshots | List of SnapshotDetailsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | PaginatedMetadataV1 | |||
| users | List of UserV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborator | ProjectCollaboratorV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasetsNotCopied | List of DatasetNotCopiedV1 | |||
| metadata | MetadataV1 | |||
| project | ProjectV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| project | ProjectV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| repository | ProjectGitRepositoryV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| defaultRef | ProjectRepositoryReferenceV1 | |||
| id | String | Id of the repository | 62604702b7e5d347dbe7a908 | |
| name | String | Optional name of the repository in the project. If not provided, a name will be inferred from the URL | ||
| serviceProvider | GitServiceProviderV1 | |||
| uri | String | URI of the repository origin | https://github.com/torvalds/linux |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goal | ProjectGoalV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | Timestamp at which goal was created | 2022-03-12T02:13:44.467Z | |
| creatorId | String | User id that created the goal | ||
| description | String | Optional description of project goal | ||
| id | String | The unique project goal id | ||
| isComplete | Boolean | Flag indicating if the goal is complete | ||
| projectId | String | Id of project to which the goal belongs | ||
| title | String | The title of project goal |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| goals | List of ProjectGoalV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| refType | GitReferenceTypeV1 | |||
| value | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| resultsSettings | ProjectResultsSettingsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| computeClusterEnvironmentRevision | EnvironmentRevision | |||
| defaultEnvironmentRevision | EnvironmentRevision | |||
| defaultHardwareTier | HardwareTier |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| status | ProjectStatusV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| access | ProjectTemplateAccess | |||
| base64Logo | String | |||
| categories | List of string | |||
| created | String | |||
| description | String | |||
| id | String | |||
| isCompanyOfficial | Boolean | Whether or not this template is marked as official | ||
| license | String | |||
| name | String | |||
| owner | ProjectTemplateOwner | |||
| recommended | Boolean | |||
| revisionId | String | |||
| templateType | String | customer ecosystem | ||
| updated | String |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborators | List of ProjectTemplateCollaborator | |||
| visibility | String | private all_non_anonymous_users |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | |||
| name | String | |||
| owner | ProjectOwner |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| backingProject | ProjectTemplateBackingProject | |||
| projectType | String | git_based dfs | ||
| settings | ProjectSettings |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| forceImport | Boolean | optional flag to force import the template code into the main repo, overwriting all git history | ||
| importToMainRepo | Boolean | optional flag to import the template code to the main repo, Github only | ||
| name | String | name of the template | ImageNet Classifier | |
| templateId | String | id of the template | templateId | |
| templateRevisionId | String | optional id of the revision of the template | ||
| templateType | String | Specifying "ecosystem" or "customer" template type |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | |||
| included | ||||
| name | String | |||
| owner | ProjectOwner |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTag | BillingTagV1 | |||
| collaborators | List of ProjectCollaboratorV1 | List of collaborators, if any | ||
| description | String | A description of the project | ||
| id | String | Project ID | 626046fcb7e5d347dbe7a904 | |
| internalTags | List of string | Optional list of strings containing internal tags of project | ||
| isRestricted | Boolean | Whether a project is restricted | ||
| mainRepository | ProjectGitRepositoryV1 | |||
| name | String | Name of the project | My Project | |
| ownerId | String | userId of the project owner | 662604702b7e5d347dbe7a908 | |
| ownerUsername | String | username of the project owner | steve_holt | |
| visibility | ProjectVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| internalPath | String | Path to find workspace at. Used internally. | /{{ownerUsername}}/{{projectName}}/{{sessionPathComponent}}/{{runId}}/{{#if pathToOpen}}tree/{{pathToOpen}}{{/if}} | |
| port | Integer | Port to run this tool on. | 8888 | |
| requireSubdomain | Boolean | Whether workspace requires subdomains. Subdomain workspaces only work if deployment is configured to support subdomains. Defaults to false. | ||
| rewrite | Boolean | If url rewriting is necessary for routing. Defaults to false |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| expectedWait | String | Message describing estimated wait time between state changes. | Now | |
| explanation | String | Message explaining the wait time | Your run has been assigned to a machine | |
| helpText | String | Message informing the caller what should be done next | It will start being prepared for execution momentarily |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| modelVersion | RegisteredModelVersionDetailsV2 | |||
| registeredModel | RegisteredModelV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| description | String | Description of the model | Customer churn model | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. This field may be omitted when false. | ||
| latestVersion | Integer | The latest version of the model | 1 | |
| latestVersionExperimentMetrics | RegisteredModelMetricsV1 | |||
| modelApiCount | Integer | The number of model APIs associated with the latest version of the model | 1 | |
| name | String | Name of the registered model | churn-prediction | |
| ownerUsername | String | Username of the project owner | martin_hito | |
| predictionCount | Integer | The number of predictions captured for the active versions of model APIs associated with the latest version of the model | 100 | |
| project | RegisteredModelProjectSummaryV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | ID of the project housing the model | 62313ce67a0af0281c01a6a5 | |
| isGitBasedProject | Boolean | Whether the project is a git-based project | ||
| name | String | Name of the project overview housing the model | TO-DO | |
| ownerUsername | String | Name of the project owner | TO-DO |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| canEditModel | Boolean | True if the requesting user can update this model | ||
| canEditProjectAssets | Boolean | True if the requesting user has permissions to edit other assets of the project that this model belongs to. | ||
| canViewExperimentRuns | Boolean | True if the requesting user can view experiment runs of the project that this model belongs to. | ||
| canViewModelApis | Boolean | True if the requesting user can view model apis of the project that this model belongs to. | ||
| canViewProject | Boolean | True if the requesting user can view the project overview of the project that this model belongs to. | ||
| canViewProjectFiles | Boolean | True if the requesting user can view the files of the project that this model belongs to. |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| description | String | Description of the model | Customer churn model | |
| discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. This field may be omitted when false. | ||
| latestVersion | Integer | The latest version of the model | 1 | |
| name | String | Name of the registered model | churn-prediction | |
| ownerUsername | String | Username of the model's creator | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| requestingUserAccess | RegisteredModelRequestingUserAccessV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| experimentRunId | String | The name of experiment run linked to the model version | db79712b47084c27a463a188bf901943 | |
| modelName | String | Name of the registered model | churn-prediction | |
| modelVersion | Integer | The latest version of the model | 4 | |
| modelVersionDescription | String | Description of the model version | Customer churn model V1 | |
| ownerUsername | String | username of the project owner | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z | |
| versionUiDetails | RegisteredModelVersionUiDetailsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| experimentRunId | String | The experiment run ID linked to the model version (only for MLflow models) | db79712b47084c27a463a188bf901943 | |
| modelName | String | Name of the registered model | churn-prediction | |
| modelVersion | Integer | The latest version of the model | 4 | |
| modelVersionDescription | String | Description of the model version | Customer churn model V1 | |
| ownerUsername | String | username of the project owner | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| tags | RegisteredModelTagsV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z | |
| versionUiDetails | RegisteredModelVersionUiDetailsV2 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metrics | Run metrics. | |||
| params | Run parameters. | |||
| runUrl | String | The snapshotId of the dataset |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| activeModelVersionId | String | The id of the Model API | 6452f88ac21bd0c60eca087 | |
| activeVersionNumber | Integer | The active version number of the Model API | 2 | |
| activeVersionStatus | String | The status of the Model API | Running | |
| description | String | Description of the model | Customer churn model | |
| id | String | ID of the Model API | 6452f88ac21bd0c60eca085 | |
| name | String | Name of the Model API | Test Model API | |
| project | RegisteredModelProjectSummaryV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| experimentRunId | String | The name of experiment run linked to the model version | db79712b47084c27a463a188bf901943 | |
| modelName | String | Name of the registered model | churn-prediction | |
| modelVersion | Integer | The latest version of the model | 4 | |
| ownerUsername | String | username of the project owner | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
| experimentRunId | String | Optional experiment run ID linked to the model version | db79712b47084c27a463a188bf901943 | |
| modelName | String | Name of the registered model | churn-prediction | |
| modelVersion | Integer | The latest version of the model | 4 | |
| ownerUsername | String | username of the project owner | martin_hito | |
| project | RegisteredModelProjectSummaryV1 | |||
| updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| experimentRunInfo | RegisteredModelVersionExperimentRunInfoV1 | |||
| modelVersionDataSources | ||||
| modelVersionDatasets |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| experimentRunInfo | RegisteredModelVersionExperimentRunInfoV1 | |||
| modelVersionDataSources | ||||
| modelVersionDatasets |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentialId | String | |||
| owner | String | |||
| repositoryTemplateName | String | |||
| repositoryToCreateName | String | |||
| serviceProvider | GitServiceProviderV1 | |||
| visibility | ProviderRepoVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentialId | String | |||
| owner | String | |||
| repositoryToCreateName | String | |||
| serviceProvider | GitServiceProviderV1 | |||
| visibility | ProviderRepoVisibilityV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Resource Configuration following the schema in its Deployment Target Type | ||
| deploymentTargetId | String | ID of the Deployment Target this Resource Configuration belongs to | ||
| description | String | Description for the Resource Configuration | ||
| id | String | UUID for the Resource Configuration | ||
| lastModified | String | Timestamp of the last update to the resource configuration (will be the creation timestamp on creation) | ||
| name | String | Internal name for the Resource Configuration | gpu_large |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| serviceAccount | ServiceAccount |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| token | ServiceAccountToken |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| modelSpecificSchema | JSONSchema | |||
| sharedSchema | JSONSchema |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | SharedDatasetRwEntryV1 | |||
| metadata | MetadataV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| createdAt | String | When the snapshot was created | 2022-03-12T02:13:44.467Z | |
| creatorId | String | ID of the user who created this snapshot | ||
| datasetId | String | ID of the dataset this snapshot belongs to | ||
| description | String | |||
| id | String | ID of this snapshot | ||
| lastMounted | String | When the snapshot was last mounted | ||
| status | String | active markForDeletion deletionInProgress deleted pending failed copying |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| snapshot | SnapshotDetailsV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| tag | TagV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| entity | Entity | |||
| fieldChanges | List of PolymorphicFieldStateChange |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| condition | String | Condition to evaluate metric value against upperLimit/lowerLimit | lessThan lessThanEqual greaterThan greaterThanEqual between | |
| lowerLimit | Number | Lower limit in the target range for a metric; lowerLimit, upperLimit, or both must be provided | ||
| upperLimit | Number | Upper limit in the target range for a metric; lowerLimit, upperLimit, or both must be provided |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| credentialId | String | |||
| repoName | String | |||
| repoOwnerName | String | |||
| visibility | ProviderRepoVisibilityV1 | |||
| writeType | WriteTypeV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborators | List of ProjectTemplateCollaborator | The updated list of collaborators for the template. Will overwrite the existing list. | ||
| description | String | The new description for the template | ||
| isCompanyOfficial | Boolean | Whether or not to mark this template as official, indicating that it has been vetted by your company. | ||
| name | String | The new name for the template | ||
| tagNames | List of string | The updated list of tags for the template. Will overwrite the existing list. | ||
| visibility | String | The new visibility for the template | private all_non_anonymous_users |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Deployment Target following the schema in its Deployment Target Type | ||
| isGloballyAccessible | Boolean | Whether or not the Deployment Target is globally accessible | ||
| name | String | Internal name for the Deployment Target | Production | |
| resourceConfigurations | Updated Resource Configurations - updates existing resource configurations for values with specified id fields - creates new resource configurations for values without specified id fields - deletes existing resource configurations not specified in the array | |||
| userAndOrganizationIds | List of string | User and Organization IDs that can use this Deployment Target |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpointName | String | Valid name of the endpoint | completions-1 | |
| endpointType | String | Type of the endpoint | llm/v1/completions | |
| modelConfig | ModelConfigV1 | |||
| modelName | String | Name of the model | gpt-3.5 | |
| modelProvider | String | Provider of the model | openai |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaborators | List of ModelDeploymentCollaborator | List of collaborators, if any | ||
| configuration | ModelDeploymentConfiguration | |||
| deploymentTargetId | String | Id of the deployment target | ||
| description | String | This endpoint is designed to provide businesses with insights into their customer retention patterns. | ||
| isGloballyAccessible | Boolean | Whether the Model Deployment is viewable by Domino Users who are not collaborators. | ||
| models | List of NewOrUpdatedModelDetail | A list of models associated with this Model Deployment. | ||
| name | String | The Model Deployment name. | Income Classifier Deployment | |
| resourceConfigurationId | String | Id of the resource configuration |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| configuration | Object | Configuration of this Resource Configuration following the schema in its Deployment Target Type | ||
| description | String | Description for the Resource Configuration | ||
| id | String | UUID for the Resource Configuration | ||
| name | String | Internal name for the Resource Configuration | gpu_large |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| created | Boolean | Whether a new thumbnail document was created (vs replaced) | ||
| etag | String | ETag of the upserted thumbnail | ||
| filename | String | Original filename of the upserted thumbnail, if provided | ||
| sizeBytes | Number | Size of the upserted thumbnail in bytes |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| user | UserV1 |
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| workspaceSession | WorkspaceSessionCreatedV1 |