This topic provides complete reference information about all of Domino’s public REST API endpoints. For details about endpoints that are not officially public, see the legacy Domino Data Lab API documentation.
AIGateway
Get all active LLM endpoints accessible by the user
GET
/api/aigateway/v1/endpoints
Description
Get all active LLM endpoints accessible by the user
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a new endpoint
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get a endpoint by name
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update a endpoint by name
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Delete a endpoint by name
DELETE
/api/aigateway/v1/endpoints/{endpointName}
Description
Delete a endpoint by name
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
endpointName | Name of the endpoint to delete | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Deleted | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get permissions for a endpoint by name
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update permissions for a endpoint by name
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
AsyncPredictions
Request a prediction from an Async model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 413 | Request entity is larger than limits defined by server. | |
| 422 | The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. | |
| 429 | The user has sent too many requests in a given amount of time. | |
| 500 | An internal error prevented the server from performing this action |
Retrieve the result of an Async Model prediction
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
BillingTag
Get usable billing codes
GET
/api/cost/v1/billingtags
Description
Get billing codes that a user can see.
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Upsert billing codes
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get billing tag by tag name
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Deactivate billing tag
DELETE
/api/cost/v1/billingtags/{tag}
Description
Deactivate a billing tag.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
tag | tag of the billing tag to archive | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
BillingTagSettings
Get billing tags setting
GET
/api/cost/v1/billingtagSettings
Description
Get billing tags setting
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update billing tags setting
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Cost
Get the cost allocation over a time window
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 the asset cost over a time window
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 |
Set AWS Billing API Configuration
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add kubecost license key
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
CustomMetrics
Send a metric alert
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Log metric values
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Retrieve metric values
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
DatasetRw
Deprecated - Get datasets accessible to user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a dataset
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get dataset by ID
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update dataset metadata
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get dataset grants by ID
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add a grant to a dataset's existing sequence of grants
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Remove a grant from a dataset's existing sequence of grants
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get snapshots belonging to dataset
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a snapshot
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Tag a snapshot in this Dataset
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Remove a tag from a Dataset
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get snapshot
GET
/api/datasetrw/v1/snapshots/{snapshotId}
Description
Fetch a snapshot by ID. Requires List access to the dataset
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
snapshotId | Snapshot ID | string | path | 62604702b7e5d347dbe7a909 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get datasets the user has access to
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. | Undefined | query | ||
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
DataSource
Get Data Source Audit Data
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get all active Data Source the user has access to
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a Data Source
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get Data Source by ID
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update Data Source with specified ID
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Delete Data Source with specified ID
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Environments
Get Environments visible to a user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create an environment
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a Revision of an Environment
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update the restricted revision of an environment
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get an environment
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Archive an environment
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
HardwareTier
Get all hardware tiers
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a hardware tier
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update a hardware tier
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get a hardware tier by Id
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Archive a hardware tier
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Jobs
Get Jobs for a project
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 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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get Job details
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get logs for a Job
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get linked goals for a job
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Link a goal to a job
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Unlink goal from job
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 | ||
projectId | Id of project for the goal | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Start a Job
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add a tag to a Job
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Remove a tag from a Job
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Organizations
Get the Organizations for a user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create an organization
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get all organizations. Only accessible to admin users.
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 | ||
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get an organization by Id
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add a user to an org
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Remove a user from an org
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Projects
Get Projects visible to user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Archive project by id
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get project result settings
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update project result settings
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get Project by Id
GET
/api/projects/v1/projects/{projectId}
Description
Get project by id. Required permissions: `ListProject`
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | ID of the project to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add a collaborator to this project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Remove a collaborator from project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a new project by copying an existing project and providing optional overrides.
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 429 | The user has sent too many requests in a given amount of time. | |
| 500 | An internal error prevented the server from performing this action |
Get goals in this project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add a goal to this project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update project goal status
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Delete a project goal
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get all imported git repositories in this project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Add an imported git repository to this project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Remove an imported repository from project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update project status
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
ProjectsFiles
Returns the contents of a file (deprecated, use v1 endpoint instead)
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Returns the contents of a file
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
ProjectSharedDatasets
Get shared datasets that a project uses
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Link a shared dataset to this project
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Unlink a shared dataset from this project
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 |
RegisteredModels
Get Registered Models visible to user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a new a Registered Model from an experiment run
POST
/api/registeredmodels/v1
Description
Create a new a 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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Request access to a project
POST
/api/registeredmodels/v1/access/{projectId}
Description
Request access to a project
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get a list of Registered Models' names visible to user
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 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get Registered Models visible to user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get registered model version stages for a project
GET
/api/registeredmodels/v1/versions/stages/projects/{projectId}
Description
Get registered model version stages for a project
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path | ||
includeDefaults | includeDefaults flag to indicate if we want to return global stages if no overrides are set for the project | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Set registered model version stages for a project
PUT
/api/registeredmodels/v1/versions/stages/projects/{projectId}
Description
Set registered model version stages for a project
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
projectId | Project ID | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
RegisteredModelVersionStagesV1 | List of registered model version stages to set for a project RegisteredModelVersionStagesV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get a specific Registered Model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update a Registered Model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Returns list of Model APIs deployed from a specific Registered Model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get all versions of a Registered Model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a new version of a Registered Model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get a specific version of a Registered Model
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update a Registered Model version
PATCH
/api/registeredmodels/v1/{modelName}/versions/{version}
Description
Update a Registered Model version
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedRegisteredModelVersionV1 | Updated details of the registered model version UpdatedRegisteredModelVersionV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Returns list of Model APIs deployed from a specific Registered Model Version
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a review of a Registered Model
POST
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews
Description
Create a review 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 |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelReviewV1 | Details about the review to create NewRegisteredModelReviewV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | Created | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Update a review of a Registered Model - add or remove reviewers with an option to change notes, or change status to canceled with an option to change notes but cannot do both simultaneously or simply change notes
PATCH
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews/{modelReviewId}
Description
Update a review of a Registered Model by 1) adding or remove reviewers with an option to change notes, or 2) changing status to canceled with an option to change notes, but cannot do both simultaneously, or 3) changing only notes
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path | ||
modelReviewId | Id of the model review to edit | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
UpdatedRegisteredModelReviewV1 | Details about the review edit UpdatedRegisteredModelReviewV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | Updated | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Create a response to a Registered Model review
POST
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews/{modelReviewId}/responses
Description
Create a response to a Registered Model review
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path | ||
modelReviewId | Id of Model Review | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
NewRegisteredModelReviewResponseV1 | Details about the review to create NewRegisteredModelReviewResponseV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 201 | Created | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get registered model version stages valid for starting a model review
GET
/api/registeredmodels/v1/{modelName}/versions/{version}/reviewstages
Description
Get registered model version stages valid for starting a model review
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | model name | string | path | ||
version | version of the model | integer | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Validates whether a model version can transition to a given stage
PUT
/api/registeredmodels/v1/{modelName}/versions/{version}/stages/validation
Description
Validates whether a model version can transition to a given stage
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
modelName | Registered model name | string | path | ||
version | Version of the registered model | integer | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
RegisteredModelVersionStageValidationV1 | The information of the stage to transition RegisteredModelVersionStageValidationV1 |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get the possible stages of a Registered Model
GET
/api/registeredmodelstages/v1
Description
Get the possible stages of a Registered Model
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Users
Get git credential accessor for a User
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get the current user
GET
/api/users/v1/self
Description
Retrieve the current user. Required permissions: `None`
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Success | |
| 400 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Get all users visible to the current user
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
Workspaces
Create workspace session
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 | The server could not understand the request due to malformed syntax | |
| 401 | The current user cannot perform this operation because they are not logged in | |
| 403 | The current user is not authorized to perform this operation | |
| 404 | The server could not find the requested resource | |
| 500 | An internal error prevented the server from performing this action |
AIGatewayEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| endpoints | List of EndpointEnvelopeV1 | |||
| metadata | MetadataV1 |
BillingTagEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTag | BillingTagWithStatusV1 |
BillingTagsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| billingTags | List of BillingTagV1 |
BillingTagsModeEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 |
BillingTagsModeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 |
BillingTagsNotificationsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| notifications | BillingTagsSettingNotificationsV1 |
BillingTagsNotificationsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| notifications | BillingTagsSettingNotificationsV1 |
BillingTagsSettingsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 | |||
| notifications | BillingTagsSettingNotificationsV1 |
BillingTagsSettingsV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| mode | BillingTagsSettingModeV1 | |||
| notifications | BillingTagsSettingNotificationsV1 |
ComputeClusterConfigV1
| 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 |
CopyProjectSpecV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| 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. |
CostAllocationEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAllocationV1 |
CostAllocationV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| cpuCoreHours | Double | |||
| cpuCoreRequestAverage | Double | |||
| cpuCoreUsageAverage | Double | |||
| cpuCores | Double | |||
| cpuCost | Double | |||
| cpuCostAdjustment | Double | |||
| cpuEfficincy | Double | |||
| discount | Double | |||
| gpuCount | Double | |||
| gpuHours | Double | |||
| gpucost | Double | |||
| gpucostAdjustment | Double | |||
| labels | Object | |||
| loadBalancerCost | Double | |||
| loadBalancerCostAdjustment | Double | |||
| name | String | |||
| nodeType | String | |||
| pv | Object | |||
| ramCost | Double | |||
| ramCostAdjustment | Double | |||
| totalCost | Double | |||
| window | Object |
CostAssetsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| data | List of CostAssetsV1 |
DataSourceAuditDataV1
| 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 | username of user who performed the event | ||
| timestamp | String | timestamp of when event was performed | 1996-07-19T03:13:44.467Z |
DataSourceEnvelopeV1
| 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 |
DataSourceUpdateV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | DataSourceConfigV1 | |||
| credentials | DataSourceCredentialsV1 | |||
| permissions | DataSourcePermissionsV1 |
DatasetInfoV1
| 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 |
DatasetMountV1
| 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 |
DatasetNotCopiedV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| datasetInfo | DatasetInfoV1 | dataset not copied | ||
| errorMessage | String | error message explaining why dataset wasn't copied |
DatasetRwDetailsV1
| 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 |
DatasetRwEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | DatasetRwDetailsV1 | |||
| metadata | MetadataV1 |
DatasetRwGrantDetailsEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| grantDetails | List of DatasetRwGrantDetailsV1 | |||
| metadata | MetadataV1 |
DatasetRwGrantDetailsV1
| 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 |
DatasetRwGrantEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| grants | List of DatasetRwGrantV1 | |||
| metadata | MetadataV1 |
DatasetRwGrantV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| targetId | String | ID of the user within the grant | ||
| targetRole | DatasetRwRoleV1 |
DatasetRwInfoDtoV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| dataset | DatasetRwDetailsV1 | |||
| projectInfo | DatasetRwProjectInfoDtoV1 |
DeepCopyGitRepoSpecV1
| 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 |
DeleteEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metadata | MetadataV1 | |||
| success | Boolean |
EndpointEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| 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 |
EnvironmentEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environment | EnvironmentV1 | |||
| metadata | MetadataV1 |
EnvironmentOwnerV1
| 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 |
EnvironmentRevisionEnvelopeV1
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| environmentRevision | EnvironmentRevisionV1 | |||
| metadata | MetadataV1 |
EnvironmentRevisionV1
| 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 |
EnvironmentToolV1
| 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 |
EnvironmentV1
| 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 | |||
| restrictedRevision | EnvironmentRevisionV1 | |||
| selectedRevision | EnvironmentRevisionV1 | |||
| supportedClusters | List of ClusterTypeV1 | |||
| visibility | EnvironmentVisibilityV1 |
ExternalVolumeMountV1
| 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 |
GitCodeRepoSpecV1
| 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 | |||
| referenceCopy | ReferenceCopyGitRepoSpecV1 |
GitCredentialsAccessorV1
| 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 | |