domino logo
Latest (5.4)
  • Get API Key
  • REST API Reference
  • Domino Data API
  • Custom Metrics SDK
  • Domino R Package
  • The python-domino Library
  • Model Monitoring API Reference
domino logo
About Domino
Domino Data LabKnowledge BaseData Science BlogTraining
API Guide
>
REST API Reference

REST API Reference

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.

  • DatasetRw

  • Environments

  • Jobs

  • CustomMetrics

  • Organizations

  • Projects

  • Users

  • AsyncPredictions

Endpoints

DatasetRw

Deprecated - Get datasets accessible to user

GET

/api/datasetrw/v1/datasets

Description

Deprecated: Use GetDatasetsV2. Get Datasets that a user has access to

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID filter

string

query

offset

How many Datasets from the start to skip. Defaults to 0.

integer

query

limit

Max number of Datasets to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedDatasetRwEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Create a dataset

POST

/api/datasetrw/v1/datasets

Description

Create a new Dataset. Requires access to the project the dataset will originate from

Body Parameter
NameDescriptionRequired

NewDatasetRwV1

Dataset to create NewDatasetRwV1

Responses
CodeMessageDatatype

200

Success

DatasetRwEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get dataset by ID

GET

/api/datasetrw/v1/datasets/{datasetId}

Description

Get Dataset by ID. Requires List access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to retrieve

string

path

62604702b7e5d347dbe7a909

Responses
CodeMessageDatatype

200

Success

DatasetRwEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Update dataset metadata

PATCH

/api/datasetrw/v1/datasets/{datasetId}

Description

Update Dataset name or description. Requires Update access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to update

string

path

62604702b7e5d347dbe7a909

Body Parameter
NameDescriptionRequired

DatasetRwMetadataV1

Fields to update DatasetRwMetadataV1

Responses
CodeMessageDatatype

200

Success

DatasetRwEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Delete Dataset

DELETE

/api/datasetrw/v1/datasets/{datasetId}

Description

Delete a dataset. Requires PermanentDelete access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to remove from project

string

path

Responses
CodeMessageDatatype

200

Success

DatasetRwEnvelopeV1

Get dataset grants by ID

GET

/api/datasetrw/v1/datasets/{datasetId}/grants

Description

Get Dataset grants by ID. Requires List access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to get grants for

string

path

62604702b7e5d347dbe7a909

Responses
CodeMessageDatatype

200

Success

DatasetRwGrantDetailsEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

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

POST

/api/datasetrw/v1/datasets/{datasetId}/grants

Description

Add a grant to a dataset's existing sequence of grants. Requires EditSecurity access to the dataset.

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to add a grant to

string

path

Body Parameter
NameDescriptionRequired

DatasetRwGrantV1

Grant to add DatasetRwGrantV1

Responses
CodeMessageDatatype

200

Success

DatasetRwGrantEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

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

DELETE

/api/datasetrw/v1/datasets/{datasetId}/grants

Description

Remove a grant from a dataset's existing sequence of grants. Requires EditSecurity access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to remove the grant from

string

path

Body Parameter
NameDescriptionRequired

DatasetRwGrantV1

Grant to remove DatasetRwGrantV1

Responses
CodeMessageDatatype

200

Success

DatasetRwGrantEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get snapshots belonging to dataset

GET

/api/datasetrw/v1/datasets/{datasetId}/snapshots

Description

Get Snapshots belonging to a dataset. Requires List access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

ID of dataset to retrieve snapshots for

string

path

62604702b7e5d347dbe7a909

offset

How many Snapshots from the start to skip. Defaults to 0.

integer

query

limit

Max number of Snapshots to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedSnapshotEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Create a snapshot

POST

/api/datasetrw/v1/datasets/{datasetId}/snapshots

Description

Create a new Snapshot in a dataset. Requires Read access to the dataset and project access

Parameters
NameDescriptionRequiredTypeInExample

datasetId

Dataset ID

string

path

Body Parameter
NameDescriptionRequired

NewSnapshotV1

Snapshot to create NewSnapshotV1

Responses
CodeMessageDatatype

200

Success

SnapshotEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Tag a snapshot in this Dataset

POST

/api/datasetrw/v1/datasets/{datasetId}/tags

Description

Tag a snapshot in this Dataset with the given tagName. Requires Update access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

Dataset ID

string

path

Body Parameter
NameDescriptionRequired

DatasetRwTagToAddV1

Tag name and snapshot ID to apply it to DatasetRwTagToAddV1

Responses
CodeMessageDatatype

200

Success

DatasetRwEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Remove a tag from a Dataset

DELETE

/api/datasetrw/v1/datasets/{datasetId}/tags/{tagName}

Description

Remove a Tag from a dataset. Requires Update access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

datasetId

Dataset ID

string

path

tagName

Name of tag to delete

string

path

Responses
CodeMessageDatatype

200

Success

DatasetRwEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get snapshot

GET

/api/datasetrw/v1/snapshots/{snapshotId}

Description

Fetch a snapshot by ID. Requires List access to the dataset

Parameters
NameDescriptionRequiredTypeInExample

snapshotId

Snapshot ID

string

path

62604702b7e5d347dbe7a909

Responses
CodeMessageDatatype

200

Success

SnapshotEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get datasets the user has access to

GET

/api/datasetrw/v2/datasets

Description

Get Datasets that a user has access to based on dataset permissions and input filters

Parameters
NameDescriptionRequiredTypeInExample

minimumPermission

Filter for minimum dataset permission the principal needs to have in returned datasets.

Undefined

query

projectIdsToExclude

ProjectIds of datasets to exclude from result.

array

query

projectIdsToInclude

ProjectIds to get the datasets from. Should not be passed in if projectIdsToExclude is and vice versa.

array

query

includeProjectInfo

Boolean to determine whether or not to return project-info in return objects.

boolean

query

offset

How many Datasets from the start to skip. Defaults to 0.

integer

query

limit

Max number of Datasets to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedDatasetRwEnvelopeV2

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Environments

Get Environments visible to a user

GET

/api/environments/beta/environments

Description

Get environments that a user can see. Required permissions: `None`.

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

offset

How many Environments from the start to skip. Defaults to 0.

integer

query

limit

Max number of Environments to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedEnvironmentEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Create an environment

POST

/api/environments/beta/environments

Description

Create an environment. Required permissions: `CreateEnvironment, EditEnvironment, UseFileStorage`.

Note
This is a beta endpoint with known limitations.
Body Parameter
NameDescriptionRequired

NewEnvironmentV1

Environment to create NewEnvironmentV1

Responses
CodeMessageDatatype

200

Success

EnvironmentEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Create a Revison of an Environment

POST

/api/environments/beta/environments/{environmentId}/revisions

Description

Create a revision of an environment. Required permissions: `ManageEnvironments, EditEnvironment, UseFileStorage`.

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

environmentId

Id of environment to create revision of

string

path

Body Parameter
NameDescriptionRequired

NewEnvironmentRevisionV1

Environment revision to create NewEnvironmentRevisionV1

Responses
CodeMessageDatatype

200

Success

EnvironmentRevisionEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get an environment

GET

/api/environments/v1/environments/{environmentId}

Description

Get an Environment by its Id. Required permissions: `ViewEnvironment`

Parameters
NameDescriptionRequiredTypeInExample

environmentId

Id of environment to retrieve

string

path

Responses
CodeMessageDatatype

200

Success

EnvironmentEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Archive an environment

DELETE

/api/environments/v1/environments/{environmentId}

Description

Archive an Environment, removing it from the list of visible environments. Required permissions: `ManageEnvironments, EditEnvironment`

Parameters
NameDescriptionRequiredTypeInExample

environmentId

Id of environment to archive

string

path

Responses
CodeMessageDatatype

200

Success

EnvironmentEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Jobs

Get Jobs for a project

GET

/api/jobs/beta/jobs

Description

Retrieve all Jobs that belong to a project. Required permissions: `ViewJobs.`

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

projectId

Id of project to retrieve Jobs for

string

query

622a6944dde1a920fcccff0d

offset

Number of jobs from the start to skip. Defaults to 0.

integer

query

2

limit

Total number of Jobs to retrieve. Defaults to 10.

integer

query

25

sortBy

Field to sort Jobs by. Defaults to "number".

string

query

dominoStatsSortFieldName

Field in domino stats to sort by. Only used if sortBy = dominoStatsField.

string

query

r-squared

ascending

Whether to sort ascending or descending. Defaults to to False.

boolean

query

showArchived

Whether to include archived Jobs in results. Defaults to false.

boolean

query

statusFilter

Status of Jobs to fetch. Defaults to "all".

string

query

tagFilter

Tag to filter by. Must match tag name exactly.

string

query

MyTag

Responses
CodeMessageDatatype

200

Success

PaginatedJobEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get Job details

GET

/api/jobs/beta/jobs/{jobId}

Description

Retrieve a Job's details by its Id. Required permissions: `ViewJobs`.

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

jobId

Id of Job to retrieve details for

string

path

Responses
CodeMessageDatatype

200

Success

JobEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get logs for a Job

GET

/api/jobs/beta/jobs/{jobId}/logs

Description

Retrieve the logs for the Job with the specified Id. Required permissions: `ViewJobs`.

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

jobId

Id of job to get logs for

string

path

logType

Type of log to retrieve. Case insensitive.

string

query

limit

Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time.

integer

query

latestTimeNano

The epoch time in nanoseconds to start fetching from

string

query

Responses
CodeMessageDatatype

200

Success

LogsEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get linked goals for a job

GET

/api/jobs/v1/goals

Description

Retrieve goals for a Job with the specified Id. Required permissions: `ViewJobs`

Parameters
NameDescriptionRequiredTypeInExample

jobId

Id of job to link to goal

string

query

Responses
CodeMessageDatatype

200

Success

PaginatedGoalEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Link a goal to a job

POST

/api/jobs/v1/goals

Description

Link the Goal with the specified Id to a Job. Required permissions: `ViewJobs, Edit`

Parameters
NameDescriptionRequiredTypeInExample

jobId

Id of job to link to goal

string

query

Body Parameter
NameDescriptionRequired

GoalToLinkV1

undefined GoalToLinkV1

Responses
CodeMessageDatatype

200

Success

GoalEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Unlink goal from job

DELETE

/api/jobs/v1/goals/{goalId}

Description

Unlink the Goal with the specified Id from a Job. Required permissions: `ViewJobs, Edit`

Parameters
NameDescriptionRequiredTypeInExample

goalId

Id of goal to remove

string

path

jobId

Id of job to remove goal from

string

query

projectId

Id of project for the goal

string

query

Responses
CodeMessageDatatype

200

Success

DeleteEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Start a Job

POST

/api/jobs/v1/jobs

Description

Start a new Job. Required permissions: `StartJob, UseGlobalCompute`

Body Parameter
NameDescriptionRequired

NewJobV1

undefined NewJobV1

Responses
CodeMessageDatatype

200

Success

JobEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Add a tag to a Job

POST

/api/jobs/v1/jobs/{jobId}/tags

Description

Add a Tag to the Job with the specified Id. Required permissions: `ViewJobs`

Parameters
NameDescriptionRequiredTypeInExample

jobId

Id of job to add tag to

string

path

Body Parameter
NameDescriptionRequired

TagToAddV1

undefined TagToAddV1

Responses
CodeMessageDatatype

200

Success

TagEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Remove a tag from a Job

DELETE

/api/jobs/v1/jobs/{jobId}/tags/{tagId}

Description

Remove a Tag from the Job with the specified Id. Required permissions: `ViewJobs`

Parameters
NameDescriptionRequiredTypeInExample

jobId

Id of job to remove tag from

string

path

tagId

Id of tag to remove

string

path

projectId

Id of project that tag belongs to

string

query

Responses
CodeMessageDatatype

200

Success

DeleteEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

CustomMetrics

Send a metric alert

POST

/api/metricAlerts/v1

Description

Send a metric out of range alert for a monitored model. Required Permissions: None

Body Parameter
NameDescriptionRequired

MetricAlertRequestV1

Details about the metric alert to send MetricAlertRequestV1

Responses
CodeMessageDatatype

200

Success

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Log metric values

POST

/api/metricValues/v1

Description

Log metric values. Required Permissions: None

Body Parameter
NameDescriptionRequired

NewMetricValuesEnvelopeV1

List of metric values to log NewMetricValuesEnvelopeV1

Responses
CodeMessageDatatype

201

Success

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Retrieve metric values

GET

/api/metricValues/v1/{modelMonitoringId}/{metric}

Description

Retrieve metric values. Required Permissions: None

Parameters
NameDescriptionRequiredTypeInExample

modelMonitoringId

ID of the monitored model

string

path

metric

Name of the metric to retrieve

string

path

startingReferenceTimestampInclusive

Timestamp to filter metrics by referenceTimestamp >= startingReferenceTimestampInclusive. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00

string

query

endingReferenceTimestampInclusive

Timestamp to filter metrics by referenceTimestamp <= endingReferenceTimestampInclusive. Timestamp should follow the RFC3339 format with timezone e.g. 2013-07-01T17:55:13-07:00

string

query

Responses
CodeMessageDatatype

200

Success

MetricValuesEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Organizations

Get the Organizations for a user

GET

/api/organizations/v1/organizations

Description

Retrieve all Organizations of which this user is a member. Required permissions: `None`

Parameters
NameDescriptionRequiredTypeInExample

nameFilter

Optional value to filter organization names with. Must exactly match organization name.

string

query

offset

How many orgs from the start to skip. Defaults to 0.

integer

query

limit

Max number of orgs to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedOrganizationEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Create an organization

POST

/api/organizations/v1/organizations

Description

Create a new Organization. Required permissions: `Must be logged in user`

Body Parameter
NameDescriptionRequired

NewOrganizationV1

undefined NewOrganizationV1

Responses
CodeMessageDatatype

200

Success

OrganizationEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get all organizations. Only accessible to admin users.

GET

/api/organizations/v1/organizations/all

Description

Get all organizations. Required permissions: `ManageOrganizations`

Parameters
NameDescriptionRequiredTypeInExample

nameFilter

Optional value to filter organization names with.

string

query

offset

How many orgs from the start to skip. Defaults to 0.

integer

query

limit

Max number of orgs to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedOrganizationEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get an organization by Id

GET

/api/organizations/v1/organizations/{organizationId}

Description

Retrieve an Organization by its Id. Required permissions: `ViewOrganization`

Parameters
NameDescriptionRequiredTypeInExample

organizationId

Id of organization to retrieve. This is the id of the org in the users collection, not the organizations collection.

string

path

Responses
CodeMessageDatatype

200

Success

OrganizationEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Add a user to an org

PUT

/api/organizations/v1/organizations/{organizationId}/user

Description

Add a new user to an Organization. Required permissions: `EditMembers`

Parameters
NameDescriptionRequiredTypeInExample

organizationId

Id of organization to add a user to. This is the id of the org in the users collection, not the organizations collection.

string

path

Body Parameter
NameDescriptionRequired

OrganizationMemberV1

undefined OrganizationMemberV1

Responses
CodeMessageDatatype

200

Success

OrganizationEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Remove a user from an org

DELETE

/api/organizations/v1/organizations/{organizationId}/user

Description

Remove a user from an Organization. Required permissions: `EditMembers`

Parameters
NameDescriptionRequiredTypeInExample

organizationId

Id of organization to add a user to. This is the id of the org in the users collection, not the organizations collection.

string

path

memberToRemoveId

Id of user to remove from org.

string

query

Responses
CodeMessageDatatype

200

Success

OrganizationEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Projects

Get Projects visible to user

GET

/api/projects/beta/projects

Description

Get projects that a user can see. Required permissions: `ListProject`.

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

offset

How many Projects from the start to skip. Defaults to 0.

integer

query

limit

Max number of Projects to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedProjectsEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Create a project

POST

/api/projects/beta/projects

Description

Create a project. Required permissions: `CreateProject, UseFileStorage`.

Note
This is a beta endpoint with known limitations.
Body Parameter
NameDescriptionRequired

NewProjectV1

Project to create NewProjectV1

Responses
CodeMessageDatatype

200

Success

ProjectEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Archive project by id

DELETE

/api/projects/beta/projects/{projectId}

Description

Archive a project by id. Required permissions: `ArchiveProject`.

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

projectId

ID of the project to retrieve

string

path

Responses
CodeMessageDatatype

200

Success

DeleteEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get project result settings

GET

/api/projects/beta/projects/{projectId}/results-settings

Description

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

Responses
CodeMessageDatatype

200

Success

ProjectResultsSettingsEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Update project result settings

PUT

/api/projects/beta/projects/{projectId}/results-settings

Description

Note
This is a beta endpoint with known limitations.
Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

Body Parameter
NameDescriptionRequired

ProjectResultsSettingsV1

Project status ProjectResultsSettingsV1

Responses
CodeMessageDatatype

200

Success

ProjectResultsSettingsEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get Project by Id

GET

/api/projects/v1/projects/{projectId}

Description

Get project by id. Required permissions: `ListProject`

Parameters
NameDescriptionRequiredTypeInExample

projectId

ID of the project to retrieve

string

path

Responses
CodeMessageDatatype

200

Success

ProjectEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Add a collaborator to this project

POST

/api/projects/v1/projects/{projectId}/collaborators

Description

Add a collaborator to this project. Required permissions: `ManageCollaborators`

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

Body Parameter
NameDescriptionRequired

ProjectCollaboratorV1

Collaborator ID ProjectCollaboratorV1

Responses
CodeMessageDatatype

200

Success

ProjectCollaboratorEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Remove a collaborator from project

DELETE

/api/projects/v1/projects/{projectId}/collaborators/{collaboratorId}

Description

Remove a collaborator from the project. Required permissions: `ManageCollaborators`

Parameters
NameDescriptionRequiredTypeInExample

projectId

ID of the project to remove collaborator from

string

path

collaboratorId

ID of the collaborator to remove

string

path

Responses
CodeMessageDatatype

200

Success

DeleteEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get goals in this project

GET

/api/projects/v1/projects/{projectId}/goals

Description

Get goals in this project. Required permissions: `ListProject`

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

Responses
CodeMessageDatatype

200

Success

ProjectGoalsEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Add a goal to this project

POST

/api/projects/v1/projects/{projectId}/goals

Description

Add a goal to this project. Required permissions: `Edit`

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

Body Parameter
NameDescriptionRequired

NewProjectGoalV1

Goal to add NewProjectGoalV1

Responses
CodeMessageDatatype

200

Success

ProjectGoalEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Update project goal status

PATCH

/api/projects/v1/projects/{projectId}/goals/{goalId}

Description

Update project goal status. Required permissions: `Edit`

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID of the goal

string

path

goalId

ID of the goal to update

string

path

Body Parameter
NameDescriptionRequired

ProjectGoalForUpdateV1

Project goal for update ProjectGoalForUpdateV1

Responses
CodeMessageDatatype

200

Success

ProjectGoalEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Delete a project goal

DELETE

/api/projects/v1/projects/{projectId}/goals/{goalId}

Description

Delete a project goal. Required permissions: `Edit`

Parameters
NameDescriptionRequiredTypeInExample

projectId

ID of the project to delete goal from

string

path

goalId

ID of the goal to delete

string

path

Responses
CodeMessageDatatype

200

Success

DeleteEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Get all imported git repositories in this project

GET

/api/projects/v1/projects/{projectId}/repositories

Description

Get all imported git repositories in this project. Required permissions: `ListProject`

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

offset

How many Projects from the start to skip. Defaults to 0.

integer

query

limit

Max number of Projects to fetch. Defaults to 10.

integer

query

Responses
CodeMessageDatatype

200

Success

PaginatedGitRepositoriesEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Add an imported git repository to this project

POST

/api/projects/v1/projects/{projectId}/repositories

Description

Add an imported git repository to this project. Required permissions: `ChangeProjectSettings`

Parameters
NameDescriptionRequiredTypeInExample

projectId

Project ID

string

path

Body Parameter
NameDescriptionRequired

NewProjectGitRepositoryV1

Repository to add NewProjectGitRepositoryV1

Responses
CodeMessageDatatype

200

Success

ProjectGitRepositoryEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1

Remove an imported repository from project

DELETE

/api/projects/v1/projects/{projectId}/repositories/{repositoryId}

Description

Remove an imported repository from the project. Required permissions: `ChangeProjectSettings`

Parameters
NameDescriptionRequiredTypeInExample

projectId

ID of the project to remove goal from

string

path

repositoryId

ID of the repository to remove

string

path

Responses
CodeMessageDatatype

200

Success

DeleteEnvelopeV1

400

The server could not understand the request due to malformed syntax

FailureEnvelopeV1, InvalidBodyEnvelopeV1

401

The current user cannot perform this operation because they are not logged in

FailureEnvelopeV1

403

The current user is not authorized to perform this operation

FailureEnvelopeV1

404

The server could not find the requested resource

FailureEnvelopeV1

500

An internal error prevented the server from performing this action

FailureEnvelopeV1<