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