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.
| 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 Revison of an Environment
POST /api/environments/beta/environments/{environmentId}/revisions
Create a revision of an environment. Required permissions: ManageEnvironments, EditEnvironment, UseFileStorage.
| 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.
| 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.
| 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.
| 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.
| 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 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
| 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
| 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
| 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
| 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
| 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
| 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.
| 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.
| 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.
| 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.
| 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 |