Domino Platform API reference

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

Important
 The v1 endpoints of the Cost API are deprecated, but they will continue to work for backwards-compatibility. Migrate to the v2 endpoints of the Cost API for all new development.

Endpoints
To Models

AIGateway
Apps
AppVersions
AppInstances
AsyncPredictions
AuditTrail
BillingTag
BillingTagSettings
Cost
CustomMetrics
DatasetRw
DataSource
DeploymentTargets
Environments
HardwareTier
Jobs
ModelAPI
ModelAPIVersion
ModelDeployment
Organizations
Projects
ProjectsFiles
ProjectSharedDatasets
ProjectTemplates
RegisteredModels
Users
Workspaces

AIGateway
Top

Get AI Gateway Audit Data

Get all active Gateway LLMs accessible by the user

Create a new endpoint

Get a endpoint by name

Update a endpoint by name

Delete a endpoint by name

Get permissions for a endpoint by name

Update permissions for a endpoint by name

Apps
Top

List Apps

Create App

Get App by Vanity URL

Get App

Update App

Delete App

Request Access to App

Get App Views

AppVersions
Top

List App Versions

Create App Version

Get App Version

Update App Version

AppInstances
Top

List App Instances

Get App Instance

Stop App Instance

Get App Instance Logs

Get App Instance Real Time Logs

Record App Instance View

AsyncPredictions
Top

Request a prediction from an Async model

Retrieve the result of an Async Model prediction

AuditTrail
Top

fetchAuditEvents

BillingTag
Top

Get usable billing codes

Upsert billing codes

Get billing tag by tag name

Deactivate billing tag

BillingTagSettings
Top

Get billing tags setting

Update billing tags setting

Cost
Top

Get the cost allocation over a time window

Get the cost allocation summary over a time window

Get the asset cost over a time window

Set AWS Billing API Configuration

Get the cloud cost data

Get the activation status of the cost feature

Add kubecost license key

Get the cost allocation over a time window

Get accumulated cost allocation over a time window

Get the cost allocation summary over a time window

Get accumulated cost allocation summary over a time window

Get the asset cost over a time window

Get accumulated asset cost over a time window

Get the cloud cost data

Get the accumulated cloud cost data

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

DataSource
Top

Get Data Source Audit Data

Get all active Data Source the user has access to

Create a Data Source

Get Data Source by ID

Update Data Source with specified ID

Delete Data Source with specified ID

DeploymentTargets
Top

Gets all Deployment Target Types

Gets a Deployment Target Type

Gets all non-archived Deployment Targets based on the provided filters

Creates a new Deployment Target

Gets all selectable non-archived Deployment Targets based on the provided filters

Gets a Deployment Target

Updates a Deployment Target

Deletes a Deployment Target

Gets all non-archived Resource Configurations based on the provided filters

Creates a new Resource Configuration

Gets a Resource Configuration

Updates a Resource Configuration

Deletes a Resource Configuration

Gets the effective configuration for model deployments using the resource configuration

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

HardwareTier
Top

Get all hardware tiers

Create a hardware tier

Update a hardware tier

Get a hardware tier by Id

Archive a hardware tier

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

ModelAPI
Top

listModelAPIs

createModelApi

getModelApi

updateModelApi

deleteModelApi

ModelAPIVersion
Top

listModelApiVersions

createModelApiVersion

getModelApiVersion

getModelApiVersionBuildLogs

getModelApiVersionExportLogs

getModelApiVersionInstanceLogs

ModelDeployment
Top

Retrieve all Model Deployments

Create a new Model Deployment

Retrieve a specific Model Deployment

Update a Model Deployment

deleteModelDeployment

Retrieve all temporary credentials for a specific Model Deployment

Retrieve temporary credentials of a specific Model Deployment for a specific operation type

Retrieve the logs for a specific Model Deployment

startModelDeployment

stopModelDeployment

Retrieve all versions of a specific Model Deployment

Retrieve a specific version of a Model Deployment

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

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

Create a project

ProjectsFiles
Top

Returns the contents of a file (deprecated, use v1 endpoint instead)

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

ProjectTemplates
Top

Create project template

Get customer project template by id

Update a customer project template

Delete a customer project template by id.

List project templates

RegisteredModels
Top

Get Registered Models visible to user

Create a new a Registered Model from an experiment run

Request access to a project

Get a list of Registered Models' names visible to user

Get Registered Models visible to user

Get a specific Registered Model

Update a 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

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

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

AIGatewayAuditDataV1

AIGatewayAuditMetadataV1

AIGatewayEnvelopeV1

Action

Actor

Affecting

AppAccessStatus

AppCreationRequest

AppInstanceLogsResponse

AppInstanceResourceUsage

AppInstanceResourceUsageTimeseries

AppInstanceResponse

AppInstanceSummaryResponse

AppProjectResponse

AppResponse

AppSummaryResponse

AppUpdateRequest

AppUserResponse

AppVersionCreationRequest

AppVersionResponse

AppVersionUpdateRequest

AppViewsResponse

AppViewsTimeseries

AsyncPredictionEnvelopeV1

AsyncPredictionRequestEnvelopeV1

AthenaBillingConfigsV1

AuditEvent

AuditEventsResponse

BillingTagEnvelopeV1

BillingTagV1

BillingTagWithStatusV1

BillingTagsEnvelopeV1

BillingTagsModeEnvelopeV1

BillingTagsModeV1

BillingTagsNotificationsEnvelopeV1

BillingTagsNotificationsV1

BillingTagsSettingModeV1

BillingTagsSettingNotificationsV1

BillingTagsSettingsEnvelopeV1

BillingTagsSettingsV1

CloudCostDetailsV2

CloudCostEnvelopeV2

CloudCostMetricsV1

CloudCostV2

ClusterTypeV1

CommitDetailsV1

ComputeClusterConfigV1

CopyProjectSpecV1

CostActivationStatusEnvelopeV1

CostActivationStatusV1

CostAllocationCpuV2

CostAllocationEnvelopeV1

CostAllocationEnvelopeV2

CostAllocationGpuV2

CostAllocationLoadBalancerV2

CostAllocationNetworkV2

CostAllocationPvV2

CostAllocationRamV2

CostAllocationSummaryCpuV2

CostAllocationSummaryEnvelopeV1

CostAllocationSummaryEnvelopeV2

CostAllocationSummaryGpuV2

CostAllocationSummaryLoadBalancerV2

CostAllocationSummaryNetworkV2

CostAllocationSummaryPvV2

CostAllocationSummaryRamV2

CostAllocationSummaryV1

CostAllocationSummaryV2

CostAllocationV1

CostAllocationV2

CostAssetsBreakdownV2

CostAssetsByteV2

CostAssetsCpuV2

CostAssetsEnvelopeV1

CostAssetsEnvelopeV2

CostAssetsGpuV2

CostAssetsLabelsV2

CostAssetsOverheadV2

CostAssetsRamV2

CostAssetsStorageV2

CostAssetsV1

CostAssetsV1Window

CostAssetsV2

CostKeyV2

CostLabelsV2

CostPropertiesV2

CostTimeWindowV2

CreatorInfo

CredentialsType

CustomerTemplate

DataSourceAuditDataV1

DataSourceAuditEventKindV1

DataSourceAuditMetadataV1

DataSourceAuthTypeV1

DataSourceConfigV1

DataSourceCredentialTypeV1

DataSourceCredentialsV1

DataSourceEnvelopeV1

DataSourcePermissionsV1

DataSourceTypeV1

DataSourceUpdateV1

DatasetInfoV1

DatasetMountV1

DatasetNotCopiedV1

DatasetRwDetailsV1

DatasetRwEnvelopeV1

DatasetRwGrantDetailsEnvelopeV1

DatasetRwGrantDetailsV1

DatasetRwGrantEnvelopeV1

DatasetRwGrantV1

DatasetRwInfoDtoV1

DatasetRwMetadataV1

DatasetRwPermissionV1

DatasetRwProjectInfoDtoV1

DatasetRwRoleV1

DatasetRwTagToAddV1

DatasetRwTagsV1

DatasetToAddV1

DeepCopyGitRepoSpecV1

DeleteEnvelopeV1

DeploymentCustomResourceDefinition

DeploymentTarget

DeploymentTargetConfiguration

DeploymentTargetConfigurationSchemas

DeploymentTargetInfo

DeploymentTargetType

DeploymentTypeSpecificSchemas

DominoStatsV1

EffectiveModelDeploymentSchema

EndpointEnvelopeV1

EndpointPermissionsDtoV1

Entity

Environment

EnvironmentEnvelopeV1

EnvironmentOwnerTypeV1

EnvironmentOwnerV1

EnvironmentRebuildOnBaseChangesV1

EnvironmentRevision

EnvironmentRevisionBuildStatusV1

EnvironmentRevisionEnvelopeV1

EnvironmentRevisionSpecV1

EnvironmentRevisionUpdateEnvelopeV1

EnvironmentRevisionV1

EnvironmentToolV1

EnvironmentV1

EnvironmentVariableV1

EnvironmentVisibilityV1

Error

ExternalVolumeMountV1

FailureEnvelopeV1

FieldStateChange

FieldType

FreeFormJsonObjectV1

GitCodeRepoSpecV1

GitCredentialsAccessorV1

GitRef

GitRefV1

GitReferenceTypeV1

GitServiceProviderV1

GoalEnvelopeV1

GoalToLinkV1

HardwareTier

HardwareTierCapacityV1

HardwareTierComputeClusterRestrictionsV1

HardwareTierEnvelopeV1

HardwareTierFlagsV1

HardwareTierGpuConfigurationV1

HardwareTierOverProvisioningV1

HardwareTierPodCustomizationV1

HardwareTierResourcesV1

HardwareTierV1

HealthCheck

ImportFilesRepoTargetV1

InformationV1

InvalidBodyEnvelopeV1

JSONSchema

JSONSchemaType

JobDetailsV1

JobEnvelopeV1

JobLogsV1

JobStatusV1

JobUsageV1

JobV1

KubecostLicenseResponseV1

KubecostLicenseV1

LinkedGoalV1

ListAppInstancesResponse

ListAppVersionsResponse

ListAppsResponse

LogContentV1

LogTypeV1

LogsEnvelopeV1

LogsPaginationV1

MetadataV1

MetricAlertRequestV1

MetricTagV1

MetricValueV1

MetricValuesEnvelopeV1

ModelApi

ModelApiAccessConfiguration

ModelApiAccessToken

ModelApiAccessTokenCreationRequest

ModelApiCollaboratorRole

ModelApiCreationRequest

ModelApiEnvironmentVariable

ModelApiHealthCheckConfiguration

ModelApiMetadata

ModelApiPaginatedList

ModelApiSource

ModelApiUpdateRequest

ModelApiVersion

ModelApiVersionBuildLogs

ModelApiVersionCreationRequest

ModelApiVersionDeployment

ModelApiVersionDeploymentLogs

ModelApiVersionExportLogs

ModelApiVersionInstanceLogs

ModelApiVersionLogLine

ModelApiVersionLogTag

ModelApiVersionMetadata

ModelApiVersionProductionLabel

ModelApiVersionSummary

ModelApiVersionTargetState

ModelApiVolume

ModelConfigV1

ModelDeployment

ModelDeploymentCollaborator

ModelDeploymentConfiguration

ModelDeploymentCredentials

ModelDeploymentCredentialsList

ModelDeploymentLogLine

ModelDeploymentLogTag

ModelDeploymentPaginatedList

ModelDeploymentStatus

ModelDeploymentStatusOperation

ModelDetail

ModelDetailSource

ModelSource

MountedGitRepoV1

MountedProjectV1

NetAppVolumeMountV1

NewAsyncPredictionV1

NewBillingTagsV1

NewCustomerTemplate

NewDataSourceV1

NewDatasetRwV1

NewDeploymentTarget

NewEndpointV1

NewEnvironmentRevision

NewEnvironmentRevisionV1

NewEnvironmentV1

NewEnvironmentVisibilityV1

NewHardwareTier

NewHardwareTierFlagsV1

NewHardwareTierV1

NewJobV1

NewMetricValueV1

NewMetricValuesEnvelopeV1

NewModelDeployment

NewOrUpdatedModelDetail

NewOrUpdatedResourceConfiguration

NewOrganizationV1

NewProjectGitRepositoryV1

NewProjectGoalV1

NewProjectSettings

NewProjectTemplateDefinition

NewProjectTemplateSourceProject

NewProjectV1

NewProjectV2

NewRegisteredModelV1

NewRegisteredModelVersionV1

NewResourceConfiguration

NewSnapshotV1

NewWorkspaceSessionV1

OrganizationEnvelopeV1

OrganizationMemberV1

OrganizationRoleV1

OrganizationV1

PaginatedBaseTemplatesCollectionV1

PaginatedDataSourceEnvelopeV1

PaginatedDatasetRwEnvelopeV1

PaginatedDatasetRwEnvelopeV2

PaginatedDeploymentTargets

PaginatedEnvironmentEnvelopeV1

PaginatedGitCredentialsAccessorEnvelopeV1

PaginatedGitRepositoriesEnvelopeV1

PaginatedGoalEnvelopeV1

PaginatedHardwareTierEnvelopeV1

PaginatedJobEnvelopeV1

PaginatedMetadataV1

PaginatedOrganizationEnvelopeV1

PaginatedProjectsEnvelopeV1

PaginatedRegisteredModelNamesV1

PaginatedRegisteredModelVersionModelApiEnvelopeV1

PaginatedRegisteredModelVersionOverviewEnvelopeV1

PaginatedRegisteredModelsEnvelopeV1

PaginatedRegisteredModelsForUIEnvelopeV1

PaginatedResourceConfigurations

PaginatedSnapshotEnvelopeV1

PaginatedUserEnvelopeV1

PaginationFilterV1

PaginationV1

PatchRegisteredModelV1

PolymorphicFieldStateChange

PositiveInteger

PositiveIntegerDefault0

ProjectCollaboratorEnvelopeV1

ProjectCollaboratorV1

ProjectCopyResultEnvelopeV1

ProjectEnvelopeV1

ProjectGitRepositoryEnvelopeV1

ProjectGitRepositoryV1

ProjectGoalEnvelopeV1

ProjectGoalForUpdateV1

ProjectGoalV1

ProjectGoalsEnvelopeV1

ProjectOwner

ProjectRepositoryReferenceV1

ProjectResultsSettingsEnvelopeV1

ProjectResultsSettingsV1

ProjectSettings

ProjectStatusEnvelopeV1

ProjectStatusV1

ProjectTemplate

ProjectTemplateAccess

ProjectTemplateBackingProject

ProjectTemplateCollaborator

ProjectTemplateDefinition

ProjectTemplateDetailsV1

ProjectTemplateOwner

ProjectTemplateSourceProject

ProjectTemplateSourceProjectComponent

ProjectV1

ProjectVisibilityV1

ProviderRepoVisibilityV1

ProxyConfigV1

QueuedJobStatusDetailsV1

ReferenceCopyGitRepoSpecV1

RegisteredModelForUIV1

RegisteredModelMetricsV1

RegisteredModelProjectSummaryV1

RegisteredModelRequestingUserAccessV1

RegisteredModelTagsV1

RegisteredModelV1

RegisteredModelVersionDataSourceDetailsV1

RegisteredModelVersionDatasetDetailsV1

RegisteredModelVersionDetailsV1

RegisteredModelVersionExperimentRunInfoV1

RegisteredModelVersionExperimentRunMetricV1

RegisteredModelVersionExperimentRunParamV1

RegisteredModelVersionModelApiV1

RegisteredModelVersionOverviewV1

RegisteredModelVersionUiDetailsV1

RepoToCreateV1

RepoToCreateV2

ResourceConfiguration

ResourceConfigurationInfo

ScalarFieldStateChange

SchemaArray

SequenceFieldStateChange

SharedAndModelSpecificSchemas

SharedDatasetRwEntryV1

SharedDatasetsEnvelopeV1

SnapshotDetailsV1

SnapshotEnvelopeV1

StageTimesV1

StreamedResponseDTO

StringArray

StringStringMap

TagEnvelopeV1

TagToAddV1

TagV1

Target

TargetList

TargetRangeV1

TemplateBackingGitCodeSpec

TokenPaginatedMetadataV1

TokenPaginationV1

UpdateCustomerTemplate

UpdateEnvironmentRevisionV1

UpdatedDeploymentTarget

UpdatedEndpointPermissionsV1

UpdatedEndpointV1

UpdatedModelDeployment

UpdatedResourceConfiguration

UserEnvelopeV1

UserV1

UsingList

WorkspaceSessionCreatedEnvelopeV1

WorkspaceSessionCreatedV1

WriteTypeV1