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.
CustomMetrics
Send a metric alert
/api/metricAlerts/v1
Send a metric out of range alert for a monitored model. Required Permissions: None
Name | Description | Required |
---|---|---|
| Details about the metric alert to send MetricAlertRequestV1 |
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
/api/metricValues/v1
Log metric values. Required Permissions: None
Name | Description | Required |
---|---|---|
| List of metric values to log NewMetricValuesEnvelopeV1 |
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
/api/metricValues/v1/{modelMonitoringId}/{metric}
Retrieve metric values. Required Permissions: None
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of the monitored model | string | path | ||
| Name of the metric to retrieve | string | path | ||
| 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 | ||
| 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 |
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
/api/datasetrw/v1/datasets
Deprecated: Use GetDatasetsV2. Get Datasets that a user has access to
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID filter | string | query | ||
| How many Datasets from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Datasets to fetch. Defaults to 10. | integer | query |
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
/api/datasetrw/v1/datasets
Create a new Dataset. Requires access to the project the dataset will originate from
Name | Description | Required |
---|---|---|
| Dataset to create NewDatasetRwV1 |
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
/api/datasetrw/v1/datasets/{datasetId}
Get Dataset by ID. Requires List access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of dataset to retrieve | string | path | 62604702b7e5d347dbe7a909 |
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
/api/datasetrw/v1/datasets/{datasetId}
Update Dataset name or description. Requires Update access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of dataset to update | string | path | 62604702b7e5d347dbe7a909 |
Name | Description | Required |
---|---|---|
| Fields to update DatasetRwMetadataV1 |
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
/api/datasetrw/v1/datasets/{datasetId}/grants
Get Dataset grants by ID. Requires List access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of dataset to get grants for | string | path | 62604702b7e5d347dbe7a909 |
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
/api/datasetrw/v1/datasets/{datasetId}/grants
Add a grant to a dataset's existing sequence of grants. Requires EditSecurity access to the dataset.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of dataset to add a grant to | string | path |
Name | Description | Required |
---|---|---|
| Grant to add DatasetRwGrantV1 |
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
/api/datasetrw/v1/datasets/{datasetId}/grants
Remove a grant from a dataset's existing sequence of grants. Requires EditSecurity access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of dataset to remove the grant from | string | path |
Name | Description | Required |
---|---|---|
| Grant to remove DatasetRwGrantV1 |
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
/api/datasetrw/v1/datasets/{datasetId}/snapshots
Get Snapshots belonging to a dataset. Requires List access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of dataset to retrieve snapshots for | string | path | 62604702b7e5d347dbe7a909 | |
| How many Snapshots from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Snapshots to fetch. Defaults to 10. | integer | query |
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
/api/datasetrw/v1/datasets/{datasetId}/snapshots
Create a new Snapshot in a dataset. Requires Read access to the dataset and project access
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Dataset ID | string | path |
Name | Description | Required |
---|---|---|
| Snapshot to create NewSnapshotV1 |
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
/api/datasetrw/v1/datasets/{datasetId}/tags
Tag a snapshot in this Dataset with the given tagName. Requires Update access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Dataset ID | string | path |
Name | Description | Required |
---|---|---|
| Tag name and snapshot ID to apply it to DatasetRwTagToAddV1 |
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
/api/datasetrw/v1/datasets/{datasetId}/tags/{tagName}
Remove a Tag from a dataset. Requires Update access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Dataset ID | string | path | ||
| Name of tag to delete | string | path |
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
/api/datasetrw/v1/snapshots/{snapshotId}
Fetch a snapshot by ID. Requires List access to the dataset
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Snapshot ID | string | path | 62604702b7e5d347dbe7a909 |
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
/api/datasetrw/v2/datasets
Get Datasets that a user has access to based on dataset permissions and input filters
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Filter for minimum dataset permission the principal needs to have in returned datasets. | Undefined | query | ||
| ProjectIds of datasets to exclude from result. | array | query | ||
| ProjectIds to get the datasets from. Should not be passed in if projectIdsToExclude is and vice versa. | array | query | ||
| Boolean to determine whether or not to return project-info in return objects. | boolean | query | ||
| How many Datasets from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Datasets to fetch. Defaults to 10. | integer | query |
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 DataSource Audit Data
/api/datasource/v1/audit
Gets data source audit data given filter input parameters
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Datasource IDs to query audit data for | array | query | ||
| Datasource names to query audit data for | array | query | ||
| events to query - AccessDataSource, CreateDataSource, DataSourceAssociatedToProject, DataSourceDissociatedFromProject, DataSourceChangeOfOwnership, DataSourceChangeOfPermissions, DeleteDataSource | array | query | ||
| Start time (iso8601) | string | query | ||
| End time (iso8601) | string | query |
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
/api/cost/v1/allocation
Retrieve cost allocation
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| 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 the cost allocation. Accepts aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
| Start time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
| End time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
| 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 the result by cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster. | string | query | ||
| if the idle cost will be shared | boolean | query | ||
| list of namespaces to share the costs | string | query | ||
| Determines how to split shared costs among non-idle, unshared allocations. | string | query | ||
| The cost to share | string | query | ||
| The label to share the cost | string | query | ||
| If the cost will be reconciled | boolean | query | ||
| If the tenancy costs will be shared | boolean | query | ||
| If the idle cost will be calculated | boolean | query | ||
| If the external cost will be calculated | boolean | query |
Code | Message | Datatype |
---|---|---|
200 | Success |
Get the asset cost over a time window
/api/cost/v1/asset
Retrieve asset cost
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| 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 the cost allocation. Accepts aggregates cluster, namespace, pod, deployment, service, daemonset, statefulset, job, cronjob, replicaset, node, container, pv, pvc, storageclass, cluster | string | query | ||
| Start time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
| End time of the query. Accepts RFC3339 format, must be inside the window | string | query | ||
| 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 the result by cluster, namespace, pod, deployment, service, daemonset, statefulset | string | query |
Code | Message | Datatype |
---|---|---|
200 | Success |
Set AWS Billing API Configuration
/athenaConfigs
Set AWS Billing API Configuration
Name | Description | Required |
---|---|---|
| AWS Billing API Config AthenaBillingConfigsV1 |
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
/licenseKey
Add kubecost license key
Name | Description | Required |
---|---|---|
| Kubecost License Key KubecostLicenseV1 |
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
/api/environments/beta/environments
Get environments that a user can see. Required permissions: `None`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| How many Environments from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Environments to fetch. Defaults to 10. | integer | query |
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
/api/environments/beta/environments
Create an environment. Required permissions: `CreateEnvironment, EditEnvironment, UseFileStorage`.
Name | Description | Required |
---|---|---|
| Environment to create NewEnvironmentV1 |
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
/api/environments/beta/environments/{environmentId}/revisions
Create a revision of an environment. Required permissions: `ManageEnvironments, EditEnvironment, UseFileStorage`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of environment to create revision of | string | path |
Name | Description | Required |
---|---|---|
| Environment revision to create NewEnvironmentRevisionV1 |
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
/api/environments/beta/environments/{environmentId}/revisions/{revisionId}
Update a revision of an environment to mark if isRestricted. Required permissions: `ClassifyEnvironments`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of environment to mark restricted revision | string | path | ||
| Id of environment revision to mark is restricted | string | path |
Name | Description | Required |
---|---|---|
| Body of isRestricted UpdateEnvironmentRevisionV1 |
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
/api/environments/v1/environments/{environmentId}
Get an Environment by its Id. Required permissions: `ViewEnvironment`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of environment to retrieve | string | path |
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
/api/environments/v1/environments/{environmentId}
Archive an Environment, removing it from the list of visible environments. Required permissions: `ManageEnvironments, EditEnvironment`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of environment to archive | string | path |
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
/api/jobs/beta/jobs
Retrieve all Jobs that belong to a project. Required permissions: `ViewJobs.`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of project to retrieve Jobs for | string | query | 622a6944dde1a920fcccff0d | |
| Number of jobs from the start to skip. Defaults to 0. | integer | query | 2 | |
| Total number of Jobs to retrieve. Defaults to 10. | integer | query | 25 | |
| Field to sort Jobs by. Defaults to "number". | string | query | number title command startedTime duration status user commentCount dominoStatsField | |
| Field in domino stats to sort by. Only used if sortBy = dominoStatsField. | string | query | r-squared | |
| Whether to sort ascending or descending. Defaults to to False. | boolean | query | ||
| Whether to include archived Jobs in results. Defaults to false. | boolean | query | ||
| Status of Jobs to fetch. Defaults to "all". | string | query | all queued running completed archived active | |
| Tag to filter by. Must match tag name exactly. | string | query | MyTag |
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
/api/jobs/beta/jobs/{jobId}
Retrieve a Job's details by its Id. Required permissions: `ViewJobs`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of Job to retrieve details for | string | path |
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
/api/jobs/beta/jobs/{jobId}/logs
Retrieve the logs for the Job with the specified Id. Required permissions: `ViewJobs`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of job to get logs for | string | path | ||
| Type of log to retrieve. Case insensitive. | string | query | stdOut stdErr prepareOutput complete | |
| Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time. | integer | query | ||
| The epoch time in nanoseconds to start fetching from | string | query |
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
/api/jobs/v1/goals
Retrieve goals for a Job with the specified Id. Required permissions: `ViewJobs`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of job to link to goal | string | query |
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
/api/jobs/v1/goals
Link the Goal with the specified Id to a Job. Required permissions: `ViewJobs, Edit`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of job to link to goal | string | query |
Name | Description | Required |
---|---|---|
| undefined GoalToLinkV1 |
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
/api/jobs/v1/goals/{goalId}
Unlink the Goal with the specified Id from a Job. Required permissions: `ViewJobs, Edit`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of goal to remove | string | path | ||
| Id of job to remove goal from | string | query | ||
| Id of project for the goal | string | query |
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
/api/jobs/v1/jobs
Start a new Job. Required permissions: `StartJob, UseGlobalCompute`
Name | Description | Required |
---|---|---|
| undefined NewJobV1 |
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
/api/jobs/v1/jobs/{jobId}/tags
Add a Tag to the Job with the specified Id. Required permissions: `ViewJobs`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of job to add tag to | string | path |
Name | Description | Required |
---|---|---|
| undefined TagToAddV1 |
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
/api/jobs/v1/jobs/{jobId}/tags/{tagId}
Remove a Tag from the Job with the specified Id. Required permissions: `ViewJobs`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of job to remove tag from | string | path | ||
| Id of tag to remove | string | path | ||
| Id of project that tag belongs to | string | query |
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
/api/organizations/v1/organizations
Retrieve all Organizations of which this user is a member. Required permissions: `None`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Optional value to filter organization names with. Must exactly match organization name. | string | query | ||
| How many orgs from the start to skip. Defaults to 0. | integer | query | ||
| Max number of orgs to fetch. Defaults to 10. | integer | query |
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
/api/organizations/v1/organizations
Create a new Organization. Required permissions: `Must be logged in user`
Name | Description | Required |
---|---|---|
| undefined NewOrganizationV1 |
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.
/api/organizations/v1/organizations/all
Get all organizations. Required permissions: `ManageOrganizations`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Optional value to filter organization names with. | string | query | ||
| How many orgs from the start to skip. Defaults to 0. | integer | query | ||
| Max number of orgs to fetch. Defaults to 10. | integer | query |
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
/api/organizations/v1/organizations/{organizationId}
Retrieve an Organization by its Id. Required permissions: `ViewOrganization`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of organization to retrieve. This is the id of the org in the users collection, not the organizations collection. | string | path |
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
/api/organizations/v1/organizations/{organizationId}/user
Add a new user to an Organization. Required permissions: `EditMembers`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| 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 |
Name | Description | Required |
---|---|---|
| undefined OrganizationMemberV1 |
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
/api/organizations/v1/organizations/{organizationId}/user
Remove a user from an Organization. Required permissions: `EditMembers`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| 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 | ||
| Id of user to remove from org. | string | query |
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
/api/projects/beta/projects
Get projects that a user can see. Required permissions: `ListProject`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| How many Projects from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Projects to fetch. Defaults to 10. | integer | query |
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
/api/projects/beta/projects
Create a project. Required permissions: `CreateProject, UseFileStorage`.
Name | Description | Required |
---|---|---|
| Project to create NewProjectV1 |
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
/api/projects/beta/projects/{projectId}
Archive a project by id. Required permissions: `ArchiveProject`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of the project to retrieve | string | path |
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. Deprecated.
/api/projects/beta/projects/{projectId}/copy-project
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.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Information needed in order to copy a project. CopyProjectSpecBeta |
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
/api/projects/beta/projects/{projectId}/results-settings
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
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
/api/projects/beta/projects/{projectId}/results-settings
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Project status ProjectResultsSettingsV1 |
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
/api/projects/v1/projects/{projectId}
Get project by id. Required permissions: `ListProject`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of the project to retrieve | string | path |
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
/api/projects/v1/projects/{projectId}/collaborators
Add a collaborator to this project. Required permissions: `ManageCollaborators`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Collaborator ID ProjectCollaboratorV1 |
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
/api/projects/v1/projects/{projectId}/collaborators/{collaboratorId}
Remove a collaborator from the project. Required permissions: `ManageCollaborators`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of the project to remove collaborator from | string | path | ||
| ID of the collaborator to remove | string | path |
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.
/api/projects/v1/projects/{projectId}/copy-project
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.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Information needed in order to copy a project. CopyProjectSpecV1 |
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
/api/projects/v1/projects/{projectId}/goals
Get goals in this project. Required permissions: `ListProject`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
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
/api/projects/v1/projects/{projectId}/goals
Add a goal to this project. Required permissions: `Edit`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Goal to add NewProjectGoalV1 |
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
/api/projects/v1/projects/{projectId}/goals/{goalId}
Update project goal status. Required permissions: `Edit`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID of the goal | string | path | ||
| ID of the goal to update | string | path |
Name | Description | Required |
---|---|---|
| Project goal for update ProjectGoalForUpdateV1 |
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
/api/projects/v1/projects/{projectId}/goals/{goalId}
Delete a project goal. Required permissions: `Edit`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of the project to delete goal from | string | path | ||
| ID of the goal to delete | string | path |
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
/api/projects/v1/projects/{projectId}/repositories
Get all imported git repositories in this project. Required permissions: `ListProject`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path | ||
| How many Projects from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Projects to fetch. Defaults to 10. | integer | query |
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
/api/projects/v1/projects/{projectId}/repositories
Add an imported git repository to this project. Required permissions: `ChangeProjectSettings`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Repository to add NewProjectGitRepositoryV1 |
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
/api/projects/v1/projects/{projectId}/repositories/{repositoryId}
Remove an imported repository from the project. Required permissions: `ChangeProjectSettings`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| ID of the project to remove goal from | string | path | ||
| ID of the repository to remove | string | path |
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
/api/projects/v1/projects/{projectId}/status
Update the status of a project. Required permissions: `Edit`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| Project status ProjectStatusV1 |
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 |
RegisteredModels
Get Registered Models visible to user
/api/registeredmodels/v1
Get registered models that a user can see.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID of requested models. | string | query | ||
| Search parameter to retrieve models from Mlflow (currently supports name and tags) | string | query | ||
| Pagination token to go to the next page based on a previous search query. | string | query | ||
| Max number of Registered Models to fetch. Defaults to 25. | integer | query | ||
| 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 |
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
/api/registeredmodels/v1
Create a new a Registered Model from an experiment run
Name | Description | Required |
---|---|---|
| Details of the registered model to create NewRegisteredModelV1 |
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
/api/registeredmodels/v1/access/{projectId}
Request access to a project
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
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
/api/registeredmodels/v1/names
Get a list of Registered Models' names visible to user.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Search filter by model name | string | query | ||
| How many Registered Models from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Registered Models to fetch. Defaults to 10. | integer | query | ||
| Project ID of requested models. | string | query |
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
/api/registeredmodels/v1/ui
Get registered models that a user can see.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID of requested models. | string | query | ||
| Search parameter to retrieve models from Mlflow (currently supports name and tags) | string | query | ||
| globallyDiscoverable flag to indicate if we want to return globally discoverable models. Defaults to false. | boolean | query | ||
| Pagination token to go to the next page based on a previous search query. | string | query | ||
| Max number of Registered Models to fetch. Defaults to 25. | integer | query | ||
| 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 |
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
/api/registeredmodels/v1/versions/stages/projects/{projectId}
Get registered model version stages for a project
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path | ||
| includeDefaults flag to indicate if we want to return global stages if no overrides are set for the project | boolean | query |
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
/api/registeredmodels/v1/versions/stages/projects/{projectId}
Set registered model version stages for a project
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Project ID | string | path |
Name | Description | Required |
---|---|---|
| List of registered model version stages to set for a project RegisteredModelVersionStagesV1 |
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
/api/registeredmodels/v1/{modelName}
Get a specific Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path |
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
/api/registeredmodels/v1/{modelName}
Update a Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path |
Name | Description | Required |
---|---|---|
| Details of the model to update PatchRegisteredModelV1 |
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
/api/registeredmodels/v1/{modelName}/modelapis
Gets all active model Apis that were deployed from a given Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path |
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
/api/registeredmodels/v1/{modelName}/versions
Get all versions of a Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Offset for pagination from the start to skip. Defaults to 0. | integer | query | ||
| Max number of Registered Models to fetch. Defaults to 20 | integer | query |
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
/api/registeredmodels/v1/{modelName}/versions
Create a new version of a Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path |
Name | Description | Required |
---|---|---|
| Details of the model version to create NewRegisteredModelVersionV1 |
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
/api/registeredmodels/v1/{modelName}/versions/{version}
Get a specific version of a Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path |
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
/api/registeredmodels/v1/{modelName}/versions/{version}
Update a Registered Model version
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path |
Name | Description | Required |
---|---|---|
| Updated details of the registered model version UpdatedRegisteredModelVersionV1 |
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
/api/registeredmodels/v1/{modelName}/versions/{version}/modelapis
Gets all active model Apis that were deployed from a given Registered Model Version
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path |
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
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews
Create a review of a Registered Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path |
Name | Description | Required |
---|---|---|
| Details about the review to create NewRegisteredModelReviewV1 |
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 an option to change notes but cannot do both simultaneously or simply change notes
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews/{modelReviewId}
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 an option to change notes, but cannot do both simultaneously, or 3) changing only notes
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path | ||
| Id of the model review to edit | string | path |
Name | Description | Required |
---|---|---|
| Details about the review edit UpdatedRegisteredModelReviewV1 |
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
/api/registeredmodels/v1/{modelName}/versions/{version}/reviews/{modelReviewId}/responses
Create a response to a Registered Model review
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path | ||
| Id of Model Review | string | path |
Name | Description | Required |
---|---|---|
| Details about the review to create NewRegisteredModelReviewResponseV1 |
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
/api/registeredmodels/v1/{modelName}/versions/{version}/reviewstages
Get registered model version stages valid for starting a model review
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| model name | string | path | ||
| version of the model | integer | path |
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
/api/registeredmodels/v1/{modelName}/versions/{version}/stages/validation
Validates whether a model version can transition to a given stage
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Registered model name | string | path | ||
| Version of the registered model | integer | path |
Name | Description | Required |
---|---|---|
| The information of the stage to transition RegisteredModelVersionStageValidationV1 |
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
/api/registeredmodelstages/v1
Get the possible stages of a Registered Model
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
/api/users/beta/credentials/{userId}
Retrieve a users git credentials. Required permissions: `UpdateUser`.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of the User to fetch creds for | string | path |
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
/api/users/v1/self
Retrieve the current user. Required permissions: `None`
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
/api/users/v1/users
Retrieves all users visible to the current user. Required permissions: `None`
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| How many users from the start to skip. Defaults to 0. | integer | query | ||
| Max number of users to fetch. Defaults to 10. | integer | query |
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
/api/modelApis/async/v1/{asyncModelId}
Request a prediction from an Async Model
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of Async Model | string | path |
Name | Description | Required |
---|---|---|
| Information for new Async Prediction NewAsyncPredictionV1 |
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
/api/modelApis/async/v1/{asyncModelId}/{asyncPredictionId}
Retrieve the result of an Async Model prediction
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Id of Async Model | string | path | ||
| Id of Async Prediction | string | path |
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 |
AIGateway (Cloud Only)
Get all active LLM endpoints accessible by the user
/api/aigateway/v1/endpoints
Get all active LLM endpoints accessible by the user
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
/api/aigateway/v1/endpoints
Create a new endpoint
Name | Description | Required |
---|---|---|
| Details of the new endpoint to create NewEndpointV1 |
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 endpoint by name
/api/aigateway/v1/endpoints/{endpointName}
Get an endpoint by name (returns endpoint if user has access and endpoint is active)
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Name of the endpoint to get | string | path |
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 an endpoint by name
/api/aigateway/v1/endpoints/{endpointName}
Update an endpoint by name (change endpoint name, endpoint type, model name, model provider, or model config)
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Name of the endpoint to update details for | string | path |
Name | Description | Required |
---|---|---|
| Updated endpoint details UpdatedEndpointV1 |
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 an endpoint by name
/api/aigateway/v1/endpoints/{endpointName}
Delete an endpoint by name
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Name of the endpoint to delete | string | path |
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 an endpoint by name
/api/aigateway/v1/endpoints/{endpointName}/permissions
Get permissions for an endpoint by name
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Name of the endpoint to get permissions for | string | path |
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 an endpoint by name
/api/aigateway/v1/endpoints/{endpointName}/permissions
Update permissions for an endpoint by name (add or remove user IDs, or change isEveryoneAllowed)
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
| Name of the endpoint to update permissions for | string | path |
Name | Description | Required |
---|---|---|
| Updated endpoint permissions UpdatedEndpointPermissionsV1 |
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 |
ComputeClusterConfigV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
clusterType | ||||
computeEnvironmentId | String | Id of compute environment to use. | 623139857a0af0281c01a6a4 | |
computeEnvironmentRevisionSpec | ||||
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 |
CopyProjectSpecBeta
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
copyDatasets | Boolean | Whether to copy the Project's datasets or not | ||
gitCodeRepoSpec | ||||
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 | The visibility of the new Project. |
CopyProjectSpecV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
copyDatasets | Boolean | Whether to copy the Project's datasets or not | ||
gitCodeRepoSpec | ||||
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 | 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 datasource | ||
dataSourceName | String | name of the datasource | ||
dataSourceType | String | type of the datasource | ||
eventKind | ||||
metadata | ||||
performedBy | String | username of user who performed the event | ||
timestamp | String | timestamp of when event was performed | 1996-07-19T03:13:44.467Z |
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 |
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 |
DatasetRwGrantDetailsEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
grantDetails | List of DatasetRwGrantDetailsV1 | |||
metadata |
DatasetRwGrantEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
grants | List of DatasetRwGrantV1 | |||
metadata |
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 |
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 | ||||
name | String | MyOrg | ||
owner | ||||
restrictedRevision | ||||
selectedRevision | ||||
supportedClusters | List of ClusterTypeV1 | |||
visibility |
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 |
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 | ||||
id | String | Id for these git credentials | ||
name | String | Name for these git credentials | My creds | |
protocol | String | https |
JobDetailsV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
commentsCount | Integer | |||
commitDetails | ||||
computeCluster | ||||
datasetMounts | List of DatasetMountV1 | |||
dominoStats | List of DominoStatsV1 | |||
externalVolumeMounts | List of ExternalVolumeMountV1 | |||
gitRepos | List of MountedGitRepoV1 | |||
goalIds | List of string | |||
id | String | |||
mainRepoGitRef | ||||
number | Integer | |||
projects | List of MountedProjectV1 | |||
queuedJobStatusDetails | ||||
runCommand | String | |||
runLauncherId | String | |||
stageTimes | ||||
startedById | String | |||
status | ||||
tags | List of TagV1 | |||
title | String | |||
usage |
JobLogsV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
helpLink | String | Suggestion link for helpful resources. | Error. No such file or directory. | |
isComplete | Boolean | Whether all logs for the job have been retrieved. | ||
logContent | List of LogContentV1 | |||
problem | String | Description of issue that occurred in a job. | python: can't open file 'invalid.py': [Errno 2] No such file or directory |
JobV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
commitDetails | ||||
computeCluster | ||||
datasetMounts | List of DatasetMountV1 | |||
dominoStats | List of DominoStatsV1 | |||
externalVolumeMounts | List of ExternalVolumeMountV1 | |||
gitRepos | List of MountedGitRepoV1 | |||
id | String | |||
mainRepoGitRef | ||||
number | Integer | |||
projects | List of MountedProjectV1 | |||
runCommand | String | |||
runLauncherId | String | |||
stageTimes | ||||
startedById | String | |||
status | ||||
title | String | |||
usage |
LinkedGoalV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
currentStage | String | The stage this goal is currently assigned. | Ideation | |
description | String | Description of the Goal. | Develop a better performing model | |
goalId | String | Id of Goal linked to Job. | 62313cfd7a0af0281c01a6a6 | |
jobId | String | Id of Job linked to Goal. | 62313d207a0af0281c01a6a7 | |
projectId | String | Id of project resources belong to. | 62313d377a0af0281c01a6a8 | |
title | String | Name of goal. | MyGoal |
MetricValueV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
referenceTimestamp | String | Timestamp associated with the metric log entry | ||
tags | List of MetricTagV1 | List of tags associated with the metric | ||
value | Number | Value of the metric |
MetricValuesEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metadata | ||||
metricValues | List of MetricValueV1 |
MountedGitRepoV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
endingBranch | String | Branch this git repo ended at. | final-branch | |
endingCommitId | String | Ending commitId for this git repo. | dff155c9a736f9cd230eac420e3c1ef3daa0ad7e | |
id | String | Id of the git repo mounted to the Job. | 6231365e7a0af0281c01a69f | |
name | String | Name of the git repo mounted to the Job. | MyRepo | |
ref | String | |||
serviceProvider | ||||
startingBranch | String | Branch this git repo started at. | init-test-branch | |
startingCommitId | String | CommitId the git repo should be mounted at. | 4f2d5c2f54db4fbb16a093d4fb11fdb1fe0794c7 | |
uri | String | Uri for the repo being mounted. | git@github.com:apache/spark.git |
NewDatasetRwV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
description | String | Description of the dataset | ||
grants | List of DatasetRwGrantV1 | Permission grants to be assigned for this newly created dataset. Note that permissions can be edited after creation. If snapshotId is passed in, this parameter won't have any effect and caller will be assigned dataset Ownership. | ||
name | String | Name of this dataset. The name must be unique in the same project | ||
projectId | String | ID of the project this dataset belongs to. Either projectId or snapshotId must be provided | ||
snapshotId | String | ID of an existing snapshot to create a new dataset from. Either snapshotId or projectId must be provided. |
NewEnvironmentRevisionV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
dockerfileInstructions | String | |||
environmentVariables | List of EnvironmentVariableV1 | |||
image | String | Environment revision image. Required for creating a new environment | ||
postRunScript | String | |||
postSetupScript | String | |||
preRunScript | String | |||
preSetupScript | String | |||
skipCache | Boolean | |||
summary | String | |||
supportedClusters | List of ClusterTypeV1 | |||
tags | List of string | |||
useVpn | Boolean | |||
workspaceTools | List of EnvironmentToolV1 |
NewJobV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
commitId | String | Git commitId to start job from. Defaults to head commitId for the project. | 960a4c99a4cc38194cbacbcce41caa68ba5369ea | |
computeCluster | ||||
environmentId | String | Id of environment to use when creating job. Defaults to project default environment. | 623131507a0af0281c01a699 | |
environmentRevisionSpec | ||||
externalVolumeMountIds | List of string | Id's of external volumes to be mounted on this job. | 6231327c7a0af0281c01a69b623132867a0af0281c01a69c | |
hardwareTier | String | Hardware tier to use for this job. Defaults to project default hardware tier. | small-k8s | |
mainRepoGitRef | ||||
projectId | String | Id of project to create job in. | 623130ad7a0af0281c01a698 | |
runCommand | String | Command for job to run | main.py | |
snapshotDatasetsOnCompletion | Boolean | Whether to snapshot datasets mounted on the Job when the Job completes. | ||
title | String | Name of job to start | K-means clustering |
NewMetricValueV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metric | String | Name of the metric to log values for | ||
modelMonitoringId | String | ID of the monitored model to log metric values for | ||
referenceTimestamp | String | Timestamp to associate the metric log entry with. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00 | ||
tags | List of MetricTagV1 | List of tags associated with the metric | ||
value | Number | Value of the metric |
NewMetricValuesEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
newMetricValues | List of NewMetricValueV1 |
NewOrganizationV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
members | List of OrganizationMemberV1 | |||
name | String | The name for this organization | MyNewOrg |
NewProjectGitRepositoryV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
defaultRef | ||||
gitCredentialId | String | Id of the git creds to use for the repo. Credentials only apply for the current user, and other users will need to add their own unique creds. | ||
name | String | Optional name of the repository in the project | ||
serviceProvider | ||||
uri | String | URI of the repository origin | https://github.com/torvalds/linux |
NewProjectV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
description | String | Project description. | ||
isRestricted | Boolean | Optional flag for setting a new project as restricted. ProjectClassifier permission required for use. | ||
mainRepository | ||||
name | String | Name of this project. The name must be unique and cannot contain white space. | ||
ownerId | String | Optional Id of a user to own this project. Defaults to the calling user if not provided. Does not currently support creating projects owned by Organizations. | ||
templateDetails | ||||
visibility |
NewRegisteredModelV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
description | String | The description of the registered model | This model predicts housing prices | |
discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. | ||
experimentRunId | String | The id of the experiment run to create the version from | a8ea375c781d4b9c8e58469f0ad738f8 | |
modelName | String | The name of the registered model | Housing Price Predictor | |
tags |
NewRegisteredModelVersionV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
artifact | String | The artifact of the run to create the version from | LogisticRegression | |
description | String | The description of the registered model version | Logistic regression model version 2 | |
experimentRunId | String | The id of the experiment run to create the version from | a8ea375c781d4b9c8e58469f0ad738f8 |
OrganizationV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
defaultEnvironmentId | String | Id of the default environment used in the organization. | 6231327c7a0af0281c01a65f | |
id | String | Organization identifier in the users collection. | 623132867a0af0281c01a69c | |
members | List of OrganizationMemberV1 | List of the organization members. | ||
name | String | Organization name. | MyOrg |
PaginatedDatasetRwEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
datasets | List of DatasetRwDetailsV1 | |||
metadata |
PaginatedDatasetRwEnvelopeV2
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
datasets | List of DatasetRwInfoDtoV1 | |||
metadata |
PaginatedEnvironmentEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
environments | List of EnvironmentV1 | |||
metadata |
PaginatedGitCredentialsAccessorEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
credentials | List of GitCredentialsAccessorV1 | |||
metadata |
PaginatedGitRepositoriesEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metadata | ||||
repositories | List of ProjectGitRepositoryV1 |
PaginatedGoalEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
goals | List of LinkedGoalV1 | |||
metadata |
PaginatedJobEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
jobs | List of JobV1 | |||
metadata |
PaginatedOrganizationEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metadata | ||||
orgs | List of OrganizationV1 |
PaginatedProjectsEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metadata | ||||
projects | List of ProjectV1 |
PaginatedRegisteredModelVersionModelApiEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
items | List of RegisteredModelVersionModelApiV1 | |||
metadata |
PaginatedRegisteredModelVersionOverviewEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
items | List of RegisteredModelVersionOverviewV1 | |||
metadata |
PaginatedRegisteredModelsEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
items | List of RegisteredModelV1 | |||
metadata |
PaginatedRegisteredModelsForUIEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
items | List of RegisteredModelForUIV1 | |||
metadata |
PaginatedSnapshotEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metadata | ||||
snapshots | List of SnapshotDetailsV1 |
PaginatedUserEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
metadata | ||||
users | List of UserV1 |
ProjectCopyResultEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
datasetsNotCopied | List of DatasetNotCopiedV1 | |||
metadata | ||||
project |
ProjectGitRepositoryV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
defaultRef | ||||
id | String | Id of the repository | 62604702b7e5d347dbe7a908 | |
name | String | Optional name of the repository in the project. If not provided, a name will be inferred from the URL | ||
serviceProvider | ||||
uri | String | URI of the repository origin | https://github.com/torvalds/linux |
ProjectGoalV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
createdAt | String | Timestamp at which goal was created | 2022-03-12T02:13:44.467Z | |
creatorId | String | User id that created the goal | ||
description | String | Optional description of project goal | ||
id | String | The unique project goal id | ||
isComplete | Boolean | Flag indicating if the goal is complete | ||
projectId | String | Id of project to which the goal belongs | ||
title | String | The title of project goal |
ProjectGoalsEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
goals | List of ProjectGoalV1 | |||
metadata |
ProjectV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
collaborators | List of ProjectCollaboratorV1 | List of collaborators, if any | ||
description | String | A description of the project | ||
id | String | Project ID | 626046fcb7e5d347dbe7a904 | |
internal tags | List of string | Optional list of strings containing internal tags of project | restricted | |
mainRepository | ||||
name | String | Name of the project | My Project | |
ownerId | String | userId of the project owner | 662604702b7e5d347dbe7a908 | |
ownerUsername | String | username of the project owner | steve_holt | |
visibility |
ProxyConfigV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
internalPath | String | Path to find workspace at. Used internally. | /{{ownerUsername}}/{{projectName}}/{{sessionPathComponent}}/{{runId}}/{{#if pathToOpen}}tree/{{pathToOpen}}{{/if}} | |
port | Integer | Port to run this tool on. | 8888 | |
requireSubdomain | Boolean | Whether workspace requires subdomains. Subdomain workspaces only work if deployment is configured to support subdomains. Defaults to false. | ||
rewrite | Boolean | If url rewriting is necessary for routing. Defaults to false |
QueuedJobStatusDetailsV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
expectedWait | String | Message describing estimated wait time between state changes. | Now | |
explanation | String | Message explaining the wait time | Your run has been assigned to a machine | |
helpText | String | Message informing the caller what should be done next | It will start being prepared for execution momentarily |
RegisteredModelForUIV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
description | String | Description of the model | Customer churn model | |
discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. This field may be omitted when false. | ||
latestVersion | Integer | The latest version of the model | 1 | |
latestVersionExperimentMetrics | ||||
latestVersionStage | String | The current stage of the latest version of the model | Staging | |
modelApiCount | Integer | The number of model APIs associated with the latest version of the model | 1 | |
name | String | Name of the registered model | churn-prediction | |
ownerUsername | String | Username of the project owner | martin_hito | |
predictionCount | Integer | The number of predictions captured for the active versions of model APIs associated with the latest version of the model | 100 | |
project | ||||
tags | ||||
updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelProjectSummaryV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
id | String | ID of the project housing the model | 62313ce67a0af0281c01a6a5 | |
isGitBasedProject | Boolean | Whether the project is a git-based project | ||
name | String | Name of the project overview housing the model | TO-DO | |
ownerUsername | String | Name of the project owner | TO-DO |
RegisteredModelRequestingUserAccessV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
canEditModel | Boolean | True if the requesting user can update this model | ||
canEditProjectAssets | Boolean | True if the requesting user has permissions to edit other assets of the project that this model belongs to. | ||
canViewExperimentRuns | Boolean | True if the requesting user can view experiment runs of the project that this model belongs to. | ||
canViewModelApis | Boolean | True if the requesting user can view model apis of the project that this model belongs to. | ||
canViewProject | Boolean | True if the requesting user can view the project overview of the project that this model belongs to. | ||
canViewProjectFiles | Boolean | True if the requesting user can view the files of the project that this model belongs to. |
RegisteredModelReviewUserInfoV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
firstName | String | The first name of the model review user | Tuanathon | |
id | String | The id of the model review user | 452f88ac21bd0c60eca085 | |
lastName | String | The last name of the model review user | Nguyen | |
username | String | The username of the model review user | ddl-tnguyen |
RegisteredModelStageEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
items | List of RegisteredModelStageV1 | The Registered Model stages | ||
metadata |
RegisteredModelV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
description | String | Description of the model | Customer churn model | |
discoverable | Boolean | Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details. This field may be omitted when false. | ||
latestVersion | Integer | The latest version of the model | 1 | |
name | String | Name of the registered model | churn-prediction | |
ownerUsername | String | Username of the model's creator | martin_hito | |
project | ||||
requestingUserAccess | ||||
tags | ||||
updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelVersionDetailsV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
currentStage | String | The current stage of the model version | Staging | |
experimentRunId | String | The name of experiment run linked to the model version | db79712b47084c27a463a188bf901943 | |
modelName | String | Name of the registered model | churn-prediction | |
modelVersion | Integer | The latest version of the model | 4 | |
modelVersionDescription | String | Description of the model version | Customer churn model V1 | |
ownerUsername | String | username of the project owner | martin_hito | |
project | ||||
reviewSummary | ||||
tags | ||||
updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z | |
versionUiDetails |
RegisteredModelVersionModelApiV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
activeModelVersionId | String | The id of the Model API | 6452f88ac21bd0c60eca087 | |
activeVersionNumber | Integer | The active version number of the Model API | 2 | |
activeVersionStatus | String | The status of the Model API | Running | |
description | String | Description of the model | Customer churn model | |
id | String | ID of the Model API | 6452f88ac21bd0c60eca085 | |
name | String | Name of the Model API | Test Model API | |
project | ||||
updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
RegisteredModelVersionOverviewV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
createdAt | String | When the latest version of the model was created | 2022-03-12T02:13:44.467Z | |
experimentRunId | String | The name of experiment run linked to the model version | db79712b47084c27a463a188bf901943 | |
modelName | String | Name of the registered model | churn-prediction | |
modelVersion | Integer | The latest version of the model | 4 | |
ownerUsername | String | username of the project owner | martin_hito | |
project | ||||
updatedAt | String | When the latest version of the model was updated | 2022-03-12T02:13:44.467Z |
SnapshotDetailsV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
createdAt | String | When the snapshot was created | 2022-03-12T02:13:44.467Z | |
creatorId | String | ID of the user who created this snapshot | ||
datasetId | String | ID of the dataset this snapshot belongs to | ||
description | String | |||
id | String | ID of this snapshot | ||
lastMounted | String | When the snapshot was last mounted | ||
status | String | active markForDeletion deletionInProgress deleted pending failed copying |
TargetRangeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
condition | String | Condition to evaluate metric value against upperLimit/lowerLimit | lessThan lessThanEqual greaterThan greaterThanEqual between | |
lowerLimit | Number | Lower limit in the target range for a metric; lowerLimit, upperLimit, or both must be provided | ||
upperLimit | Number | Upper limit in the target range for a metric; lowerLimit, upperLimit, or both must be provided |
AIGatewayEnvelopeV1
Field Name | Required | Type | Description | Example |
---|---|---|---|---|
endpoints | List of EndpointEnvelopeV1 | |||
metadata |
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 | |
modelProvider | String | Provider of the model | openai | |
modelName | String | Name of the model | gpt-4 | |
modelConfig |