Domino Platform API reference

This topic provides complete reference information about all of Domino’s public REST API endpoints.

Endpoints
To Models

AsyncPredictions
Cost
CustomMetrics
DatasetRw
Environments
Jobs
Organizations
Projects
ProjectsFiles
ProjectSharedDatasets
RegisteredModels
Users
Workspaces

AsyncPredictions
Top

Request a prediction from an Async model

Retrieve the result of an Async Model prediction

Cost
Top

Get the cost allocation over a time window

Get the asset cost over a time window

CustomMetrics
Top

Send a metric alert

Log metric values

Retrieve metric values

DatasetRw
Top

Deprecated - Get datasets accessible to user

Create a dataset

Get dataset by ID

Update dataset metadata

Delete Dataset

Get dataset grants by ID

Add a grant to a dataset's existing sequence of grants

Remove a grant from a dataset's existing sequence of grants

Get snapshots belonging to dataset

Create a snapshot

Tag a snapshot in this Dataset

Remove a tag from a Dataset

Get snapshot

Get datasets the user has access to

Environments
Top

Get Environments visible to a user

Create an environment

Create a Revision of an Environment

Update the restricted revision of an environment

Get an environment

Archive an environment

Jobs
Top

Get Jobs for a project

Get Job details

Get logs for a Job

Get linked goals for a job

Link a goal to a job

Unlink goal from job

Start a Job

Add a tag to a Job

Remove a tag from a Job

Organizations
Top

Get the Organizations for a user

Create an organization

Get all organizations. Only accessible to admin users.

Get an organization by Id

Add a user to an org

Remove a user from an org

Projects
Top

Get Projects visible to user

Create a project

Archive project by id

Create a new project by copying an existing project and providing optional overrides. Deprecated.

Get project result settings

Update project result settings

Get Project by Id

Add a collaborator to this project

Remove a collaborator from project

Create a new project by copying an existing project and providing optional overrides.

Get goals in this project

Add a goal to this project

Update project goal status

Delete a project goal

Get all imported git repositories in this project

Add an imported git repository to this project

Remove an imported repository from project

Update project status

ProjectsFiles
Top

Returns the contents of a file

ProjectSharedDatasets
Top

Get shared datasets that a project uses

Link a shared dataset to this project

Unlink a shared dataset from this project

RegisteredModels
Top

Get Registered Models visible to user

Get a list of Registered Models' names visible to user

Get a specific Registered Model

Returns list of Model APIs deployed from a specific Registered Model

Get all versions of a Registered Model

Create a new version of a Registered Model

Get a specific version of a Registered Model

Update a Registered Model version

Returns list of Model APIs deployed from a specific Registered Model Version

Create a review of a Registered Model

Update a review of a Registered Model - add or remove reviewers with an option to change notes, or change status to canceled with an option to change notes but cannot do both simultaneously or simply change notes

Create a response to a Registered Model review

Get the possible stages of a Registered Model

Users
Top

Get git credential accessor for a User

Get the current user

Get all users visible to the current user

Workspaces
Top

Create workspace session

Models
Top

AsyncPredictionEnvelopeV1

AsyncPredictionRequestEnvelopeV1

ClusterTypeV1

CommitDetailsV1

ComputeClusterConfigV1

CopyProjectSpecBeta

CopyProjectSpecV1

CostAllocationEnvelopeV1

CostAllocationV1

CostAssetsEnvelopeV1

CostAssetsV1

CostAssetsV1Window

DatasetInfoV1

DatasetMountV1

DatasetNotCopiedV1

DatasetRwDetailsV1

DatasetRwEnvelopeV1

DatasetRwGrantDetailsEnvelopeV1

DatasetRwGrantDetailsV1

DatasetRwGrantEnvelopeV1

DatasetRwGrantV1

DatasetRwInfoDtoV1

DatasetRwMetadataV1

DatasetRwPermissionV1

DatasetRwProjectInfoDtoV1

DatasetRwRoleV1

DatasetRwTagToAddV1

DatasetRwTagsV1

DatasetToAddV1

DeepCopyGitRepoSpecBeta

DeepCopyGitRepoSpecV1

DeleteEnvelopeV1

DominoStatsV1

EnvironmentEnvelopeV1

EnvironmentOwnerTypeV1

EnvironmentOwnerV1

EnvironmentRevisionBuildStatusV1

EnvironmentRevisionEnvelopeV1

EnvironmentRevisionSpecV1

EnvironmentRevisionUpdateEnvelopeV1

EnvironmentRevisionV1

EnvironmentToolV1

EnvironmentV1

EnvironmentVariableV1

EnvironmentVisibilityV1

ExternalVolumeMountV1

FailureEnvelopeV1

GitCodeRepoSpecBeta

GitCodeRepoSpecV1

GitCredentialsAccessorV1

GitRefV1

GitReferenceTypeV1

GitServiceProviderV1

GoalEnvelopeV1

GoalToLinkV1

HealthCheck

InvalidBodyEnvelopeV1

JobDetailsV1

JobEnvelopeV1

JobLogsV1

JobStatusV1

JobUsageV1

JobV1

LinkedGoalV1

LogContentV1

LogTypeV1

LogsEnvelopeV1

LogsPaginationV1

MetadataV1

MetricAlertRequestV1

MetricTagV1

MetricValueV1

MetricValuesEnvelopeV1

MountedGitRepoV1

MountedProjectV1

NewAsyncPredictionV1

NewDatasetRwV1

NewEnvironmentRevisionV1

NewEnvironmentV1

NewEnvironmentVisibilityV1

NewJobV1

NewMetricValueV1

NewMetricValuesEnvelopeV1

NewOrganizationV1

NewProjectGitRepositoryV1

NewProjectGoalV1

NewProjectV1

NewRegisteredModelReviewResponseV1

NewRegisteredModelReviewReviewersV1

NewRegisteredModelReviewV1

NewRegisteredModelVersionV1

NewSnapshotV1

NewWorkspaceSessionV1

OrganizationEnvelopeV1

OrganizationMemberV1

OrganizationRoleV1

OrganizationV1

PaginatedDatasetRwEnvelopeV1

PaginatedDatasetRwEnvelopeV2

PaginatedEnvironmentEnvelopeV1

PaginatedGitCredentialsAccessorEnvelopeV1

PaginatedGitRepositoriesEnvelopeV1

PaginatedGoalEnvelopeV1

PaginatedJobEnvelopeV1

PaginatedMetadataV1

PaginatedOrganizationEnvelopeV1

PaginatedProjectsEnvelopeV1

PaginatedRegisteredModelNamesV1

PaginatedRegisteredModelVersionModelApiEnvelopeV1

PaginatedRegisteredModelVersionOverviewEnvelopeV1

PaginatedRegisteredModelsEnvelopeV1

PaginatedSnapshotEnvelopeV1

PaginatedUserEnvelopeV1

PaginationV1

ProjectCollaboratorEnvelopeV1

ProjectCollaboratorV1

ProjectCopyResultEnvelopeV1

ProjectEnvelopeV1

ProjectGitRepositoryEnvelopeV1

ProjectGitRepositoryV1

ProjectGoalEnvelopeV1

ProjectGoalForUpdateV1

ProjectGoalV1

ProjectGoalsEnvelopeV1

ProjectRepositoryReferenceV1

ProjectResultsSettingsEnvelopeV1

ProjectResultsSettingsV1

ProjectStatusEnvelopeV1

ProjectStatusV1

ProjectV1

ProjectVisibilityV1

ProviderRepoVisibilityV1

ProxyConfigV1

QueuedJobStatusDetailsV1

ReferenceCopyGitRepoSpecV1

RegisteredModelProjectSummaryV1

RegisteredModelReviewSummaryV1

RegisteredModelReviewUserInfoV1

RegisteredModelStageEnvelopeV1

RegisteredModelStageV1

RegisteredModelTagsV1

RegisteredModelV1

RegisteredModelVersionDetailsV1

RegisteredModelVersionModelApiV1

RegisteredModelVersionOverviewV1

SharedDatasetRwEntryV1

SharedDatasetsEnvelopeV1

SnapshotDetailsV1

SnapshotEnvelopeV1

StageTimesV1

StreamedResponseDTO

TagEnvelopeV1

TagToAddV1

TagV1

TargetRangeV1

UpdateEnvironmentRevisionV1

UpdatedRegisteredModelReviewV1

UpdatedRegisteredModelVersionV1

UserEnvelopeV1

UserV1

WorkspaceSessionCreatedEnvelopeV1

WorkspaceSessionCreatedV1