The Domino Public APIs lets users access Domino code to perform specific and customized operations. API endpoints are available for:
-
APIKey KeyParamName: Authorization, KeyInQuery: false, KeyInHeader: true
-
APIKey KeyParamName: X-Domino-Api-Key, KeyInQuery: false, KeyInHeader: true
Tag a snapshot in this Dataset
POST /api/datasetrw/v1/datasets/{datasetId}/tags
Tag a snapshot in this Dataset with the given tagName. Required permissions: ManageDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Dataset ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Tag name and snapshot ID to apply it to DatasetRwTagToAddV1 | X |
-
application/json
| 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
POST /api/datasetrw/v1/datasets
Create a new Dataset. Required permissions: ManageDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Dataset to create NewDatasetRwV1 | X |
-
application/json
| 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
POST /api/datasetrw/v1/datasets/{datasetId}/snapshots
Create a new Snapshot in a Dataset. Required permissions: ManageDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Dataset ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Snapshot to create NewSnapshotV1 | X |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Delete Dataset
DELETE /api/datasetrw/v1/datasets/{datasetId}
Delete a Dataset. Required permissions: ManageDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Dataset to remove from Project | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success |
Get Dataset by ID
GET /api/datasetrw/v1/datasets/{datasetId}
Get Dataset by ID. Required permissions: GetDatasetsRw,ListProject
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Dataset to retrieve | X | null |
-
application/json
| 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
GET /api/datasetrw/v1/datasets/{datasetId}/snapshots
Get Snapshots belonging to a Dataset. Required permissions: GetDatasetsRw,ListProject
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Dataset to retrieve snapshots for | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| How many Snapshots from the start to skip. Defaults to 0. | - | null |
| Max number of Snapshots to fetch. Defaults to 10. | - | null |
-
application/json
| 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 visible to user
GET /api/datasetrw/v1/datasets
Get Datasets that a user can see. Required permissions: GetDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID filter | - | null |
| How many Datasets from the start to skip. Defaults to 0. | - | null |
| Max number of Datasets to fetch. Defaults to 10. | - | null |
-
application/json
| 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
GET /api/datasetrw/v1/snapshots/{snapshotId}
Fetch a snapshot by ID. Required permissions: GetDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Snapshot ID | X | null |
-
application/json
| 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
DELETE /api/datasetrw/v1/datasets/{datasetId}/tags/{tagName}
Remove a Tag from a Dataset. Required permissions: ManageDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Dataset ID | X | null |
| Name of tag to delete | X | null |
-
application/json
| 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
PATCH /api/datasetrw/v1/datasets/{datasetId}
Update Dataset name or description. Required permissions: ManageDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Dataset to update | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Fields to update DatasetRwMetadataV1 | X |
-
application/json
| 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
DELETE /api/environments/v1/environments/{environmentId}
Archive an Environment, removing it from the list of visible environments. Required permissions: ManageEnvironments, EditEnvironment
| Name | Description | Required | Default |
|---|---|---|---|
| ID of environment to archive | X | null |
-
application/json
| 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
POST /api/environments/beta/environments
Create an environment. Required permissions: CreateEnvironment, EditEnvironment, UseFileStorage.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| Environment to create NewEnvironmentV1 | X |
-
application/json
| 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
POST /api/environments/beta/environments/{environmentId}/revisions
Create a revision of an environment. Required permissions: ManageEnvironments, EditEnvironment, UseFileStorage.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| Environment ID of created revision | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Environment revision to create NewEnvironmentRevisionV1 | X |
-
application/json
| 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
GET /api/environments/v1/environments/{environmentId}
Get an Environment by its ID. Required permissions: ViewEnvironment
| Name | Description | Required | Default |
|---|---|---|---|
| ID of environment to retrieve | X | null |
-
application/json
| 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 Environments visible to a user
GET /api/environments/beta/environments
Get environments that a user can see. Required permissions: None.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| How many Environments from the start to skip. Defaults to 0. | - | null |
| Max number of Environments to fetch. Defaults to 10. | - | null |
-
application/json
| 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
POST /api/jobs/v1/jobs/{jobId}/tags
Add a Tag to the Job with the specified ID. Required permissions: ViewJobs
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to add tag to | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| X |
-
application/json
| 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
GET /api/jobs/beta/jobs/{jobId}
Retrieve a Job’s details by its ID. Required permissions: ViewJobs.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to retrieve details for | X | null |
-
application/json
| 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
GET /api/jobs/beta/jobs/{jobId}/logs
Retrieve the logs for the Job with the specified ID. Required permissions: ViewJobs.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to get logs for | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Type of log to retrieve. Case insensitive. | - | null |
| Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time. | - | null |
| The epoch time in nanoseconds to start fetching from | - | null |
-
application/json
| 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 Jobs for a Project
GET /api/jobs/beta/jobs
Retrieve all Jobs that belong to a Project. Required permissions: ViewJobs.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Project to retrieve Jobs for | X | null |
| Number of jobs from the start to skip. Defaults to 0. | - | null |
| Total number of Jobs to retrieve. Defaults to 10. | - | null |
| Field to sort Jobs by. Defaults to "number". | - | null |
| Field in domino stats to sort by. Only used if sortBy = dominoStatsField. | - | null |
| Whether to sort ascending or descending. Defaults to False. | - | null |
| Whether to include archived Jobs in results. Defaults to false. | - | null |
| Status of Jobs to fetch. Defaults to "all". | - | null |
| Tag to filter by. Must match tag name exactly. | - | null |
-
application/json
| 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
GET /api/jobs/v1/goals
Retrieve goals for a Job with the specified ID. Required permissions: ViewJobs
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to link to goal | X | null |
-
application/json
| 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
POST /api/jobs/v1/goals
Link the Goal with the specified ID to a Job. Required permissions: ViewJobs, Edit
| Name | Description | Required | Default |
|---|---|---|---|
| X |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to link to goal | X | null |
-
application/json
| 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
DELETE /api/jobs/v1/jobs/{jobId}/tags/{tagId}
Remove a Tag from the Job with the specified ID. Required permissions: ViewJobs
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to remove tag from | X | null |
| ID of tag to remove | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Project that tag belongs to | X | null |
-
application/json
| 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
POST /api/jobs/v1/jobs
Start a new Job. Required permissions: StartJob, UseGlobalCompute
| Name | Description | Required | Default |
|---|---|---|---|
| X |
-
application/json
| 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
DELETE /api/jobs/v1/goals/{goalId}
Unlink the Goal with the specified ID from a Job. Required permissions: ViewJobs, Edit
| Name | Description | Required | Default |
|---|---|---|---|
| ID of goal to remove | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Job to remove goal from | X | null |
| ID of Project for the goal | X | null |
-
application/json
| 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
PUT /api/organizations/v1/organizations/{organizationId}/user
Add a new user to an Organization. Required permissions: EditMembers
|
Note
| This endpoint is deprecated. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of organization to add a user to. This is the ID of the org in the users collection, not the organizations collection. | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| X |
-
application/json
| 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
POST /api/organizations/v1/organizations
Create a new Organization. Required permissions: Must be logged in user
|
Note
| This endpoint is deprecated. |
| Name | Description | Required | Default |
|---|---|---|---|
| X |
-
application/json
| 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.
GET /api/organizations/v1/organizations/all
Get all organizations. Required permissions: ManageOrganizations
|
Note
| This endpoint is deprecated. |
| Name | Description | Required | Default |
|---|---|---|---|
| Optional value to filter organization names with. | - | null |
| How many orgs from the start to skip. Defaults to 0. | - | null |
| Max number of orgs to fetch. Defaults to 10. | - | null |
-
application/json
| 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
GET /api/organizations/v1/organizations/{organizationId}
Retrieve an Organization by its ID. Required permissions: ViewOrganization
|
Note
| This endpoint is deprecated. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of organization to retrieve. This is the ID of the org in the users collection, not the organizations collection. | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Get the Organizations for a user
GET /api/organizations/v1/organizations
Retrieve all Organizations of which the user is a member. Required permissions: None
|
Note
| This endpoint is deprecated. |
| Name | Description | Required | Default |
|---|---|---|---|
| Optional value to filter organization names with. Must exactly match organization name. | - | null |
| How many orgs from the start to skip. Defaults to 0. | - | null |
| Max number of orgs to fetch. Defaults to 10. | - | null |
-
application/json
| 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
DELETE /api/organizations/v1/organizations/{organizationId}/user
Remove a user from an Organization. Required permissions: EditMembers
|
Note
| This endpoint is deprecated. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of organization to add a user to. This is the ID of the org in the users collection, not the organizations collection. | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of user to remove from org. | X | null |
-
application/json
| 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 shared Dataset to this Project
POST /api/projects/v1/projects/{projectId}/shared-datasets
Link a shared Dataset to this Project. Required permissions: ManageDatasetsRw,UseFileStorage
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Dataset ID DatasetToAddV1 | X |
-
application/json
| 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 shared Datasets that a Project uses
GET /api/projects/v1/projects/{projectId}/shared-datasets
List shared Datasets used by a Project. Required permissions: GetDatasetsRw
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
-
application/json
| 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 a shared Dataset from this Project
DELETE /api/projects/v1/projects/{projectId}/shared-datasets/{datasetId}
Unlink the Dataset with the specified ID from a Project. Required permissions: ManageDatasetsRw,UseFileStorage
| Name | Description | Required | Default |
|---|---|---|---|
| ID of Project | X | null |
| ID of shared Dataset to remove | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success |
Add a collaborator to this Project
POST /api/projects/v1/projects/{projectId}/collaborators
Add a collaborator to this Project. Required permissions: ManageCollaborators
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Collaborator ID ProjectCollaboratorV1 | X |
-
application/json
| 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
POST /api/projects/v1/projects/{projectId}/goals
Add a goal to this Project. Required permissions: Edit
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Goal to add NewProjectGoalV1 | X |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Add an imported Git repository to this Project
POST /api/projects/v1/projects/{projectId}/repositories
Add an imported Git repository to this Project. Required permissions: ChangeProjectSettings
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Repository to add NewProjectGitRepositoryV1 | X |
-
application/json
| 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
DELETE /api/projects/beta/projects/{projectId}
Archive a Project by ID. Required permissions: ArchiveProject.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of the Project to retrieve | X | null |
-
application/json
| 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
POST /api/projects/beta/projects
Create a Project. Required permissions: CreateProject, UseFileStorage.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| Project to create NewProjectV1 | X |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Delete a Project goal
DELETE /api/projects/v1/projects/{projectId}/goals/{goalId}
Delete a Project goal. Required permissions: Edit
| Name | Description | Required | Default |
|---|---|---|---|
| ID of the Project to delete goal from | X | null |
| ID of the goal to delete | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Get all imported Git repositories in this Project
GET /api/projects/v1/projects/{projectId}/repositories
Get all imported Git repositories in this Project. Required permissions: ListProject
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| How many Projects from the start to skip. Defaults to 0. | - | null |
| Max number of Projects to fetch. Defaults to 10. | - | null |
-
application/json
| 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
GET /api/projects/v1/projects/{projectId}
Get Project by ID. Required permissions: ListProject
| Name | Description | Required | Default |
|---|---|---|---|
| ID of the Project to retrieve | X | null |
-
application/json
| 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 goals in this Project
GET /api/projects/v1/projects/{projectId}/goals
Get goals in this Project. Required permissions: ListProject
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
-
application/json
| 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 Projects visible to user
GET /api/projects/beta/projects
Get Projects that a user can see. Required permissions: ListProject.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| How many Projects from the start to skip. Defaults to 0. | - | null |
| Max number of Projects to fetch. Defaults to 10. | - | null |
-
application/json
| 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
DELETE /api/projects/v1/projects/{projectId}/collaborators/{collaboratorId}
Remove a collaborator from the Project. Required permissions: ManageCollaborators
| Name | Description | Required | Default |
|---|---|---|---|
| ID of the Project to remove collaborator from | X | null |
| ID of the collaborator to remove | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Remove an imported repository from Project
DELETE /api/projects/v1/projects/{projectId}/repositories/{repositoryId}
Remove an imported repository from the Project. Required permissions: ChangeProjectSettings
| Name | Description | Required | Default |
|---|---|---|---|
| ID of the Project to remove goal from | X | null |
| ID of the repository to remove | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Update Project goal status
PATCH /api/projects/v1/projects/{projectId}/goals/{goalId}
Update Project goal status. Required permissions: Edit
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID of the goal | X | null |
| ID of the goal to update | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Project goal for update ProjectGoalForUpdateV1 | X |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Update Project status
PUT /api/projects/v1/projects/{projectId}/status
Update the status of a Project. Required permissions: Edit
| Name | Description | Required | Default |
|---|---|---|---|
| Project ID | X | null |
| Name | Description | Required | Default |
|---|---|---|---|
| Project status ProjectStatusV1 | X |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Get the current user
GET /api/users/v1/self
Retrieve the current user. Required permissions: None
-
application/json
| 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 Git credential accessor for a User
GET /api/users/beta/credentials/{userId}
Retrieve a users Git credentials. Required permissions: UpdateUser.
|
Note
| This is a beta endpoint with known limitations. |
| Name | Description | Required | Default |
|---|---|---|---|
| ID of the User to fetch creds for | X | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
Get all users visible to the current user
GET /api/users/v1/users
Retrieves all users visible to the current user. Required permissions: None
| Name | Description | Required | Default |
|---|---|---|---|
| How many users from the start to skip. Defaults to 0. | - | null |
| Max number of orgs to fetch. Defaults to 10. | - | null |
-
application/json
| Code | Message | Datatype |
|---|---|---|
200 | Success | |
400 | The server could not understand the request due to malformed syntax | |
401 | The current user cannot perform this operation because they are not logged in | |
403 | The current user is not authorized to perform this operation | |
404 | The server could not find the requested resource | |
500 | An internal error prevented the server from performing this action |
ComputeClusterConfigV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
clusterType | X | ClusterTypeV1 | ||
computeEnvironmentId | X | String | ID of compute environment to use. | |
computeEnvironmentRevisionSpec | String | Specification describing which environment revision to use. Defaults to "ActiveRevision" | ||
masterHardwareTierId | String | Hardware tier to use for master node in compute cluster. | ||
maxWorkerCount | Integer | Max number of workers to use in compute cluster. Enables auto-scaling for cluster when present. | ||
workerCount | X | Integer | Number of workers to use in compute cluster. Used as min number of workers in maxWorkerCount is set. | |
workerHardwareTier | X | String | Hardware tier to use for workers in compute cluster. | |
workerStorageMB | BigDecimal | Disk size in MB for each worker. |
DatasetMountV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
containerPath | String | Location Dataset is mounted at in the Job. | ||
datasetName | X | String | Name of Dataset to be mounted. | |
id | X | String | ID of Dataset to be mounted. | |
isInput | X | Boolean | Whether a Dataset was an input to be used in the execution, or an output created by the execution. | |
projectId | X | String | ID of Project the Dataset belongs to. | |
snapshotId | String | ID of snapshot to mount for this Dataset. | ||
snapshotVersion | Integer | Version of Dataset snapshot to mount. |
DatasetRwDetailsV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdAt | X | Date | When the Dataset was created | date-time |
description | String | A description of the Dataset | ||
id | X | String | ID of the Dataset | |
name | X | String | Name of the Dataset | |
projectId | String | ID of the Project this Dataset belongs to | ||
snapshotIds | X | List of [string] | List of snapshot IDs belonging to this Dataset | |
tags | X | Map of [string] | A map of tagName -> snapshotId |
EnvironmentRevisionV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
availableTools | X | List of EnvironmentToolV1 | ||
id | X | String | ID of Environment Revision. | |
number | X | Integer | Revision number, increasing sequentially with each revision. | |
status | EnvironmentRevisionBuildStatusV1 |
EnvironmentV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
archived | X | Boolean | Whether the environment is archived | |
id | X | String | ID of environment | |
latestRevision | EnvironmentRevisionV1 | |||
name | X | String | ||
owner | EnvironmentOwnerV1 | |||
selectedRevision | EnvironmentRevisionV1 | |||
supportedClusters | X | List of ClusterTypeV1 | ||
visibility | X | EnvironmentVisibilityV1 |
ExternalVolumeMountV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
mountPath | X | String | Path to mount the external volume at. | |
name | X | String | Name of external volume to mount. | |
readOnly | X | Boolean | Whether to mount the volume as read only. | |
subPath | String | Path within the external volume to mount. The entire volume will be mounted if not specified. |
FailureEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
errors | X | List of [string] | Errors that caused a request to fail | |
requestId | X | String | ID used to correlate a request with server actions. |
JobDetailsV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commentsCount | X | Integer | ||
commitDetails | X | CommitDetailsV1 | ||
computeCluster | ComputeClusterConfigV1 | |||
datasetMounts | X | List of DatasetMountV1 | ||
dominoStats | X | List of DominoStatsV1 | ||
externalVolumeMounts | X | List of ExternalVolumeMountV1 | ||
gitRepos | X | List of MountedGitRepoV1 | ||
goalIds | X | List of [string] | ||
id | X | String | ||
mainRepoGitRef | GitRefV1 | |||
number | X | Integer | ||
projects | X | List of MountedProjectV1 | ||
queuedJobStatusDetails | QueuedJobStatusDetailsV1 | |||
runCommand | X | String | ||
runLauncherId | String | |||
stageTimes | X | StageTimesV1 | ||
startedById | String | |||
status | X | JobStatusV1 | ||
tags | X | List of TagV1 | ||
title | String | |||
usage | JobUsageV1 |
JobLogsV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
helpLink | String | Suggestion link for helpful resources. | ||
isComplete | X | Boolean | Whether all logs for the Job have been retrieved. | |
logContent | X | List of LogContentV1 | ||
problem | String | Description of issue that occurred in a Job. |
JobV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commitDetails | X | CommitDetailsV1 | ||
computeCluster | ComputeClusterConfigV1 | |||
datasetMounts | X | List of DatasetMountV1 | ||
dominoStats | X | List of DominoStatsV1 | ||
externalVolumeMounts | X | List of ExternalVolumeMountV1 | ||
gitRepos | X | List of MountedGitRepoV1 | ||
id | X | String | ||
mainRepoGitRef | GitRefV1 | |||
number | X | Integer | ||
projects | X | List of MountedProjectV1 | ||
runCommand | X | String | ||
runLauncherId | String | |||
stageTimes | X | StageTimesV1 | ||
startedById | String | |||
status | X | JobStatusV1 | ||
title | String | |||
usage | JobUsageV1 |
LinkedGoalV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
currentStage | X | String | The stage this goal is currently assigned. | |
description | String | Description of the Goal. | ||
goalId | X | String | ID of Goal linked to Job. | |
jobId | X | String | ID of Job linked to Goal. | |
projectId | X | String | ID of Project resources belong to. | |
title | X | String | Name of goal. |
LogsEnvelopeV1Metadata
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
notices | X | List of [string] | Notices relating to the request | |
pagination | X | LogsPaginationV1 | ||
requestId | X | String | ID used to correlate a request with server actions. |
MetadataV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
notices | X | List of [string] | Notices relating to the request | |
requestId | X | String |
MountedGitRepoV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endingBranch | String | Branch this Git repo ended at. | ||
endingCommitId | String | Ending commitId for this Git repo. | ||
id | X | String | ID of the Git repo mounted to the Job. | |
name | X | String | Name of the Git repo mounted to the Job. | |
ref | X | String | ||
serviceProvider | X | GitServiceProviderV1 | ||
startingBranch | String | Branch this Git repo started at. | ||
startingCommitId | String | `CommitId` the Git repo should be mounted at. | ||
uri | X | String | Uri for the repo being mounted. |
NewDatasetRwV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
description | String | Description of the Dataset | ||
name | X | String | Name of this Dataset. The name must be unique in the same Project | |
projectId | String | ID of the Project this Dataset belongs to. Either projectId or snapshotId must be provided | ||
snapshotId | String | ID of an existing snapshot to create a new Dataset from. Either snapshotId or projectId must be provided |
NewEnvironmentRevisionV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
dockerfileInstructions | String | |||
environmentVariables | List of EnvironmentVariableV1 | |||
image | X | String | ||
postRunScript | String | |||
postSetupScript | String | |||
preRunScript | String | |||
preSetupScript | String | |||
skipCache | Boolean | |||
summary | String | |||
supportedClusters | List of ClusterTypeV1 | |||
useVpn | Boolean | |||
workspaceTools | List of EnvironmentToolV1 |
NewEnvironmentV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
dockerfileInstructions | String | |||
environmentVariables | List of EnvironmentVariableV1 | |||
image | X | String | ||
postRunScript | String | |||
postSetupScript | String | |||
preRunScript | String | |||
preSetupScript | String | |||
skipCache | Boolean | |||
summary | String | |||
supportedClusters | List of ClusterTypeV1 | |||
useVpn | Boolean | |||
workspaceTools | List of EnvironmentToolV1 | |||
addBaseDependencies | X | Boolean | ||
description | String | |||
name | X | String | ||
orgOwnerId | String | Sets an Organization as the Environment owner. Only used if visibility is 'Private', as 'Global' environments don't have owners. | ||
visibility | X | NewEnvironmentVisibilityV1 |
NewJobV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commitId | String | Git `commitId` to start Job from. Defaults to head `commitId` for the Project. | ||
computeCluster | ComputeClusterConfigV1 | |||
environmentId | String | ID of environment to use when creating Job. Defaults to Project default environment. | ||
environmentRevisionSpec | String | Specification describing which environment revision to use. Defaults to "ActiveRevision" | ||
externalVolumeMountIds | List of [string] | ID's of external volumes to be mounted on this Job. | ||
hardwareTier | String | Hardware tier to use for this Job. Defaults to Project default hardware tier. | ||
mainRepoGitRef | GitRefV1 | |||
projectId | X | String | ID of Project in which Job is created. | |
runCommand | X | String | Command for Job to run. | |
title | String | Name of Job to start. |
NewOrganizationV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
members | X | List of OrganizationMemberV1 | ||
name | X | String | The name for this organization |
NewProjectGitRepositoryV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultRef | ProjectRepositoryReferenceV1 | |||
gitCredentialId | String | ID of the Git credentials to use for the repo. Credentials only apply for the current user, and other users will need to add their own unique creds. | ||
name | String | Optional name of the repository in the Project | ||
serviceProvider | GitServiceProviderV1 | |||
uri | X | String | URI of the repository origin |
NewProjectV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
description | X | String | Project description. | |
mainRepository | NewProjectGitRepositoryV1 | |||
name | X | String | Name of this Project. The name must be unique and cannot contain white space. | |
ownerId | String | Optional ID of a user to own this Project. Defaults to the calling user if not provided. Does not currently support creating Projects owned by Organizations. | ||
visibility | X | ProjectVisibilityV1 |
NewSnapshotV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
relativeFilePaths | X | List of [string] | List of paths to include in snapshot |
OrganizationV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultEnvironmentId | String | ID of the default environment used in the organization. | ||
id | X | String | Organization identifier in the users collection. | |
members | X | List of OrganizationMemberV1 | List of the organization members. | |
name | X | String | Organization name. |
PaginatedDatasetRwEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
datasets | X | List of DatasetRwDetailsV1 | ||
metadata | X | PaginatedMetadataV1 |
PaginatedEnvironmentEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
environments | X | List of EnvironmentV1 | ||
metadata | X | PaginatedMetadataV1 |
PaginatedGitCredentialsAccessorEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
credentials | X | List of GitCredentialsAccessorV1 | ||
metadata | X | MetadataV1 |
PaginatedGitRepositoriesEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata | X | PaginatedMetadataV1 | ||
repositories | X | List of ProjectGitRepositoryV1 |
PaginatedGoalEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
goals | X | List of LinkedGoalV1 | ||
metadata | X | MetadataV1 |
PaginatedJobEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
jobs | X | List of JobV1 | ||
metadata | X | PaginatedMetadataV1 |
PaginatedMetadataV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
notices | X | List of [string] | Notices relating to the request | |
requestId | X | String | ||
limit | X | Integer | Max number of objects returned | |
offset | X | Integer | Number of object skipped forward from start of objects | |
totalCount | Integer | Total number of available objects |
PaginatedOrganizationEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata | X | PaginatedMetadataV1 | ||
orgs | X | List of OrganizationV1 |
PaginatedProjectsEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata | X | PaginatedMetadataV1 | ||
projects | X | List of ProjectV1 |
PaginatedSnapshotEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata | X | PaginatedMetadataV1 | ||
snapshots | X | List of SnapshotDetailsV1 |
PaginatedUserEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata | X | PaginatedMetadataV1 | ||
users | X | List of UserV1 |
ProjectGitRepositoryV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultRef | X | ProjectRepositoryReferenceV1 | ||
id | X | String | ID of the repository | |
name | String | Optional name of the repository in the Project. If not provided, a name will be inferred from the URL | ||
serviceProvider | X | GitServiceProviderV1 | ||
uri | X | String | URI of the repository origin |
ProjectGoalV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdAt | X | Date | Timestamp at which goal was created | date-time |
creatorId | X | String | User ID that created the goal | |
description | String | Optional description of Project goal | ||
id | X | String | The unique Project goal ID | |
isComplete | X | Boolean | Flag indicating if the goal is complete | |
projectId | X | String | ID of Project to which the goal belongs | |
title | X | String | The title of Project goal |
ProjectGoalsEnvelopeV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
goals | X | List of ProjectGoalV1 | ||
metadata | X | MetadataV1 |
ProjectV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
collaborators | X | List of ProjectCollaboratorV1 | List of collaborators, if any | |
description | X | String | A description of the Project | |
id | X | String | Project ID | |
mainRepository | ProjectGitRepositoryV1 | |||
name | X | String | Name of the Project | |
ownerId | X | String | `userId` of the Project owner | |
ownerUsername | X | String | `username` of the Project owner | |
visibility | X | ProjectVisibilityV1 |
ProxyConfigV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
internalPath | X | String | Path to find workspace at. Used internally. | |
port | X | Integer | Port to run this tool on. | |
requireSubdomain | Boolean | Whether workspace requires subdomains. Subdomain workspaces only work if deployment is configured to support subdomains. Defaults to false. | ||
rewrite | Boolean | If URL rewriting is necessary for routing. Defaults to false |
SharedDatasetRwEntryV1
An object describing the shared Datasets imported into a Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
projectId | X | String | ID of the Project being described. | |
sharedDatasetIds | X | List of [string] | List of Dataset IDs shared with this Project |
SnapshotDetailsV1
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdAt | X | Date | When the snapshot was created | date-time |
creatorId | String | ID of the user who created this snapshot | ||
datasetId | X | String | ID of the Dataset this snapshot belongs to | |
description | String | |||
id | X | String | ID of this snapshot | |
lastMounted | Date | When the snapshot was last mounted | date-time | |
status | X | String | Enum: active, markForDeletion, deletionInProgress, deleted, pending, failed, copying, |