Skip to content
On-premise users: click in-app to access the full platform documentation for your version of DataRobot.
DataRobot API resources > API reference documentation > DataRobot REST API > Applications > Custom applications

Custom Applications

This page outlines the operations, endpoints, parameters, and example requests and responses for the Custom Applications.

GET /api/v2/customApplicationSources/

List of custom application sources.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplicationSources/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
orderBy query string false The sort order applied to the list of custom application sources. Prefix the attribute name with a dash to sort in descending order, e.g. "-createdAt".
name query string false Allows for searching custom application sources by name.

Enumerated Values

Parameter Value
orderBy [name, -name, createdAt, -createdAt, updatedAt, -updatedAt]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "id": "string",
      "latestVersion": {
        "baseEnvironmentId": "string",
        "baseEnvironmentVersionId": "string",
        "createdAt": "string",
        "createdBy": "string",
        "creatorFirstName": "string",
        "creatorLastName": "string",
        "creatorUserhash": "string",
        "id": "string",
        "isFrozen": true,
        "items": [
          {
            "commitSha": "string",
            "created": "string",
            "fileName": "string",
            "filePath": "string",
            "fileSource": "string",
            "id": "string",
            "ref": "string",
            "repositoryFilePath": "string",
            "repositoryLocation": "string",
            "repositoryName": "string"
          }
        ],
        "label": "string",
        "updatedAt": "string",
        "userId": "string"
      },
      "name": "string",
      "orgId": "string",
      "permissions": [
        "CAN_PUBLISH_NEW_IMAGE"
      ],
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customApplicationSources/

Create a custom application source.

Code samples

curl -X POST https://app.datarobot.com/api/v2/customApplicationSources/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CustomApplicationSourceCreate}'

Body parameter

{
  "name": "string"
}

Parameters

Name In Type Required Description
body body CustomApplicationSourceCreate false none

Example responses

200 Response

{
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "createdAt": "string",
    "createdBy": "string",
    "creatorFirstName": "string",
    "creatorLastName": "string",
    "creatorUserhash": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "updatedAt": "string",
    "userId": "string"
  },
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_PUBLISH_NEW_IMAGE"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSource
202 Accepted Creation has successfully started. None
403 Forbidden User does not have permission to create a source. None
422 Unprocessable Entity Custom application source could not be created with the given input. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customApplicationSources/fromCustomTemplate/

Create a custom application source from a template.

Code samples

curl -X POST https://app.datarobot.com/api/v2/customApplicationSources/fromCustomTemplate/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CustomApplicationSourceFromGalleryTemplateCreate}'

Body parameter

{
  "customTemplateId": "string"
}

Parameters

Name In Type Required Description
body body CustomApplicationSourceFromGalleryTemplateCreate false none

Example responses

200 Response

{
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "createdAt": "string",
    "createdBy": "string",
    "creatorFirstName": "string",
    "creatorLastName": "string",
    "creatorUserhash": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "updatedAt": "string",
    "userId": "string"
  },
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_PUBLISH_NEW_IMAGE"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSource
202 Accepted The custom application source creation process has successfully started. See the location header. None
403 Forbidden The current user does not have permission to create a custom application source. None
422 Unprocessable Entity A custom application source could not be created with the selected custom template. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customApplicationSources/{appSourceId}/

Delete a custom application source.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.

Responses

Status Meaning Description Schema
204 No Content The source has been deleted. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplicationSources/{appSourceId}/

Retrieve a source.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.

Example responses

200 Response

{
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "createdAt": "string",
    "createdBy": "string",
    "creatorFirstName": "string",
    "creatorLastName": "string",
    "creatorUserhash": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "updatedAt": "string",
    "userId": "string"
  },
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_PUBLISH_NEW_IMAGE"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSource

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customApplicationSources/{appSourceId}/

Update a source's name.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "name": "string"
}

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
body body CustomApplicationSourceUpdate false none

Responses

Status Meaning Description Schema
204 No Content The source has been updated. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplicationSources/{appSourceId}/sharedRoles/

Get a list of users, groups, and organizations with access to this application source.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
appSourceId path string true The ID of the application source.

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none SharingListV2Response

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customApplicationSources/{appSourceId}/sharedRoles/

Share an application source with a user, group, or organization.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/sharedRoles/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "note": "",
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ],
  "sendNotification": false
}

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
body body ApplicationSharingUpdateOrRemove false none

Responses

Status Meaning Description Schema
204 No Content The roles was updated successfully. None
422 Unprocessable Entity The request was formatted improperly. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplicationSources/{appSourceId}/versions/

List of custom application source versions.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
appSourceId path string true The ID of the application source.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "baseEnvironmentId": "string",
      "baseEnvironmentVersionId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "id": "string",
      "isFrozen": true,
      "items": [
        {
          "commitSha": "string",
          "created": "string",
          "fileName": "string",
          "filePath": "string",
          "fileSource": "string",
          "id": "string",
          "ref": "string",
          "repositoryFilePath": "string",
          "repositoryLocation": "string",
          "repositoryName": "string"
        }
      ],
      "label": "string",
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceVersionListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customApplicationSources/{appSourceId}/versions/

Create a custom application source.

Code samples

curl -X POST https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "baseVersion": "string",
  "file": "string",
  "filePath": "string",
  "filesToDelete": "string",
  "label": "string"
}

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
body body CustomApplicationSourceVersionCreate false none

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceVersion
201 Created Source version was successfully created. None
403 Forbidden User does not have permission to create a new source version. None
422 Unprocessable Entity Custom application source version could not be created with the given input. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/

Delete a custom application source version.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
appSourceVersionId path string true The ID of the application source version.

Responses

Status Meaning Description Schema
204 No Content The source version has been deleted. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/

Retrieve a source version.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
appSourceVersionId path string true The ID of the application source version.

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceVersion

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/

Update the source version

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "file": "string",
  "filePath": "string",
  "filesToDelete": "string",
  "label": "string"
}

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
appSourceVersionId path string true The ID of the application source version.
body body CustomApplicationSourceVersionUpdate false none

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceVersion

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/fromCodespace/

Update files in the source version from Codespace.

Code samples

curl -X POST https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/fromCodespace/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "codespaceId": "string",
  "label": "string"
}

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
appSourceVersionId path string true The ID of the application source version.
body body CustomApplicationSourceVersionFromCodespace false none

Example responses

200 Response

{
  "id": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceVersionFromCodespaceResponse
202 Accepted Task for updating source applied. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/items/{itemId}/

Retrieve a file stored inside a custom application source version.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/items/{itemId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
appSourceVersionId path string true The ID of the application source version.
itemId path string true The ID of file item inside of the application source version.

Example responses

200 Response

{
  "content": "string",
  "fileName": "string",
  "filePath": "string",
  "id": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationItemRetrieve

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/toCodespace/

Update files in the source version from Codespace.

Code samples

curl -X POST https://app.datarobot.com/api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/toCodespace/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "codespaceId": "string"
}

Parameters

Name In Type Required Description
appSourceId path string true The ID of the application source.
appSourceVersionId path string true The ID of the application source version.
body body CustomApplicationSourceVersionToCodespace false none

Example responses

200 Response

{
  "id": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationSourceVersionFromCodespaceResponse
202 Accepted Task for uploading applied. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplications/

List of applications created by the currently authenticated user.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplications/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
orderBy query string false The sort order applied to the list of custom applications. Prefix the attribute name with a dash to sort in descending order, e.g. "-createdAt".
name query string false Allows for searching custom applications by name.
customApplicationSourceId query any false Allows you to get custom applications created only from specific sources. To find apps not linked to a custom application source, use the value "null".
includeSourceLabels query boolean false Whether or not you want to include the name of the application source andthe label of the source version.
requireSource query boolean false Whether we should only fetch apps created from a custom application source.

Enumerated Values

Parameter Value
orderBy [name, -name, createdAt, -createdAt, updatedAt, -updatedAt]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "allowAutoStopping": true,
      "applicationUrl": "http://example.com",
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "customApplicationSourceId": "string",
      "customApplicationSourceVersionId": "string",
      "envVersionId": "string",
      "expiresAt": "2019-08-24T14:15:22Z",
      "externalAccessEnabled": true,
      "externalAccessRecipients": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "orgId": "string",
      "permissions": [
        "CAN_CHANGE_EXTERNAL_ACCESS"
      ],
      "sourceName": "string",
      "sourceVersionLabel": "string",
      "status": "created",
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customApplications/

Create a custom application

Code samples

curl -X POST https://app.datarobot.com/api/v2/customApplications/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CustomApplicationCreate}'

Body parameter

{
  "applicationSourceId": "string",
  "applicationSourceVersionId": "string",
  "environmentId": "string",
  "name": "string",
  "resources": {
    "replicas": 0,
    "resourceLabel": "string",
    "serviceWebRequestsOnRootPath": true,
    "sessionAffinity": true
  }
}

Parameters

Name In Type Required Description
body body CustomApplicationCreate false none

Example responses

200 Response

{
  "allowAutoStopping": true,
  "applicationUrl": "http://example.com",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "customApplicationSourceId": "string",
  "customApplicationSourceVersionId": "string",
  "envVersionId": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "externalAccessEnabled": true,
  "externalAccessRecipients": [
    "string"
  ],
  "id": "string",
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_CHANGE_EXTERNAL_ACCESS"
  ],
  "sourceName": "string",
  "sourceVersionLabel": "string",
  "status": "created",
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplication
202 Accepted Creation has successfully started. See the Location header. None
403 Forbidden User does not have permission to launch application of provided type. None
422 Unprocessable Entity Application could not be created with the given input. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customApplications/{applicationId}/

Delete an application

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/customApplications/{applicationId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
applicationId path string true The ID of the application

Responses

Status Meaning Description Schema
204 No Content The application has been deleted. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplications/{applicationId}/

Retrieve an application

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplications/{applicationId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
includeSourceLabels query boolean false Whether or not you want to include the name of the application source andthe label of the source version.
applicationId path string true The ID of the application

Example responses

200 Response

{
  "allowAutoStopping": true,
  "applicationUrl": "http://example.com",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "customApplicationSourceId": "string",
  "customApplicationSourceVersionId": "string",
  "envVersionId": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "externalAccessEnabled": true,
  "externalAccessRecipients": [
    "string"
  ],
  "id": "string",
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_CHANGE_EXTERNAL_ACCESS"
  ],
  "sourceName": "string",
  "sourceVersionLabel": "string",
  "status": "created",
  "updatedAt": "string",
  "userId": "string"
}

Responses

Status Meaning Description Schema
200 OK none CustomApplication

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customApplications/{applicationId}/

Update an application's name

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/customApplications/{applicationId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "allowAutoStopping": true,
  "customApplicationSourceVersionId": "string",
  "externalAccessEnabled": true,
  "externalAccessRecipients": [
    "string"
  ],
  "name": "string"
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body CustomApplicationUpdate false none

Responses

Status Meaning Description Schema
204 No Content The application has been updated. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplications/{applicationId}/history/

Retrieve an application's publication history.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplications/{applicationId}/history/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
applicationId path string true The ID of the application

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "sourceId": "string",
      "sourceName": "string",
      "sourceVersionId": "string",
      "sourceVersionLabel": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationsHistoryListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplications/{applicationId}/logs/

Retrieve an application's logs

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplications/{applicationId}/logs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
applicationId path string true The ID of the application

Example responses

200 Response

{
  "buildError": "string",
  "buildLog": "string",
  "buildStatus": "string",
  "logs": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationLogs

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplications/{applicationId}/sharedRoles/

Get a list of users, groups and organizations that have an access to this application

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplications/{applicationId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
applicationId path string true The ID of the application

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none SharingListV2Response

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customApplications/{applicationId}/sharedRoles/

Share an application with a user, group, or organization

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/customApplications/{applicationId}/sharedRoles/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "note": "",
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ],
  "sendNotification": false
}

Parameters

Name In Type Required Description
applicationId path string true The ID of the application
body body ApplicationSharingUpdateOrRemove false none

Responses

Status Meaning Description Schema
204 No Content The roles updated successfully None
422 Unprocessable Entity The request was formatted improperly. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customApplications/{applicationId}/usages/

Retrieve an application's usages

Code samples

curl -X GET https://app.datarobot.com/api/v2/customApplications/{applicationId}/usages/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
applicationId path string true The ID of the application

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "userId": "string",
      "userType": "guest",
      "username": "string",
      "visitTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CustomApplicationsUsagesListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customTemplates/

Retrieve a list of custom templates.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customTemplates/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
orderBy query string false The order to sort the custom templates.
search query string false Only return custom templates whose name or description contain this text.
tag query string false Only return custom templates with a matching tag.
templateSubType query string false Only return custom templates of this sub-type.
templateType query string false Only return custom templates of this type.
publisher query string false Only return custom templates with this publisher.
category query string false Only return custom templates with this category (use case).

Enumerated Values

Parameter Value
orderBy [name, -name, createdAt, -createdAt, templateType, -templateType, templateSubType, -templateSubType]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "defaultEnvironment": {
        "environmentId": "string",
        "environmentVersionId": "string"
      },
      "defaultResourceBundleId": "cpu.nano",
      "description": "string",
      "enabled": true,
      "id": "string",
      "items": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "name": "string",
      "templateMetadata": {
        "classLabels": [
          "string"
        ],
        "readme": "string",
        "resourceBundleIds": [
          "string"
        ],
        "source": {},
        "tags": [
          "string"
        ],
        "templateTypeSpecificResources": {
          "serviceWebRequestsOnRootPath": false
        }
      },
      "templateSubType": "string",
      "templateType": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK A paginated list of custom templates. CustomTemplateListResponse
403 Forbidden User does not have permission to access custom templates. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customTemplates/

Create a custom template.

Code samples

curl -X POST https://app.datarobot.com/api/v2/customTemplates/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CustomTemplateCreatePayload}'

Body parameter

{
  "defaultEnvironment": "string",
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "file": "string",
  "name": "string",
  "templateMetadata": "string",
  "templateSubType": "string",
  "templateType": "string"
}

Parameters

Name In Type Required Description
body body CustomTemplateCreatePayload false none

Responses

Status Meaning Description Schema
201 Created Custom template is successfully created. None
403 Forbidden User does not have permission to create a custom template. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customTemplates/{customTemplateId}/

Delete a custom template.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/customTemplates/{customTemplateId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTemplateId path string true The ID of the custom template.

Responses

Status Meaning Description Schema
204 No Content Requested custom template has been successfully deleted None
403 Forbidden User does not have permission to delete a custom template. None
404 Not Found Custom template was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customTemplates/{customTemplateId}/

Retrieve a single custom template.

Code samples

curl -X GET https://app.datarobot.com/api/v2/customTemplates/{customTemplateId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
customTemplateId path string true The ID of the custom template.

Example responses

200 Response

{
  "defaultEnvironment": {
    "environmentId": "string",
    "environmentVersionId": "string"
  },
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "id": "string",
  "items": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "name": "string",
  "templateMetadata": {
    "classLabels": [
      "string"
    ],
    "readme": "string",
    "resourceBundleIds": [
      "string"
    ],
    "source": {},
    "tags": [
      "string"
    ],
    "templateTypeSpecificResources": {
      "serviceWebRequestsOnRootPath": false
    }
  },
  "templateSubType": "string",
  "templateType": "string"
}

Responses

Status Meaning Description Schema
200 OK A given custom template. CustomTemplateEntity
403 Forbidden User does not have permission to access a particular custom template. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customTemplates/{customTemplateId}/

Update given custom template.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/customTemplates/{customTemplateId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "defaultEnvironment": "string",
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "file": "string",
  "name": "string",
  "templateMetadata": "string",
  "templateSubType": "string",
  "templateType": "string"
}

Parameters

Name In Type Required Description
customTemplateId path string true The ID of the custom template.
body body CustomTemplateUpdatePayload false none

Example responses

200 Response

{
  "defaultEnvironment": {
    "environmentId": "string",
    "environmentVersionId": "string"
  },
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "id": "string",
  "items": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "name": "string",
  "templateMetadata": {
    "classLabels": [
      "string"
    ],
    "readme": "string",
    "resourceBundleIds": [
      "string"
    ],
    "source": {},
    "tags": [
      "string"
    ],
    "templateTypeSpecificResources": {
      "serviceWebRequestsOnRootPath": false
    }
  },
  "templateSubType": "string",
  "templateType": "string"
}

Responses

Status Meaning Description Schema
200 OK Custom template successfully updated. CustomTemplateEntity
403 Forbidden User does not have permission to update a custom template. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

AccessControlV2

{
  "id": "string",
  "name": "string",
  "role": "ADMIN",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The identifier of the recipient.
name string true The name of the recipient.
role string true The role of the recipient on this entity.
shareRecipientType string true The type of the recipient.

Enumerated Values

Property Value
role [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER]
shareRecipientType [user, group, organization]

ApplicationSharingUpdateOrRemove

{
  "note": "",
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ],
  "sendNotification": false
}

Properties

Name Type Required Restrictions Description
note string false A note to go with the project share
operation string true Name of the action being taken. The only operation is 'updateRoles'.
roles [oneOf] true maxItems: 100
minItems: 1
 Array of GrantAccessControl objects., up to maximum 100 objects.

oneOf

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithUsername false none

xor

Name Type Required Restrictions Description
» anonymous GrantAccessControlWithId false none

continued

Name Type Required Restrictions Description
sendNotification boolean false Send a notification?

Enumerated Values

Property Value
operation updateRoles

CustomAppHistory

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "sourceId": "string",
  "sourceName": "string",
  "sourceVersionId": "string",
  "sourceVersionLabel": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true The date and time that the user published a new version of the app.
createdBy string,null false The username of the user who published the application.
creatorFirstName string,null false The first name of the user who published the application.
creatorLastName string,null false The last name of the user who published the application.
creatorUserhash string,null false The Gravatar hash of the user who published the application.
sourceId string true The custom application source ID of the record.
sourceName string false The name of the custom app source.
sourceVersionId string true The custom application source version ID of the record.
sourceVersionLabel string false The label of the source version.

CustomAppUsage

{
  "userId": "string",
  "userType": "guest",
  "username": "string",
  "visitTimestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
userId string,null true The ID of the user (or null for a guest).
userType string,null true Determines whether the user was a creator, viewer, or guest at the time of visit.
username string true maxLength: 512
minLength: 1
minLength: 1
 The name of the user.
visitTimestamp string(date-time) true The date and time that user last visited the app.

Enumerated Values

Property Value
userType [guest, viewer, creator]

CustomApplication

{
  "allowAutoStopping": true,
  "applicationUrl": "http://example.com",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "customApplicationSourceId": "string",
  "customApplicationSourceVersionId": "string",
  "envVersionId": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "externalAccessEnabled": true,
  "externalAccessRecipients": [
    "string"
  ],
  "id": "string",
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_CHANGE_EXTERNAL_ACCESS"
  ],
  "sourceName": "string",
  "sourceVersionLabel": "string",
  "status": "created",
  "updatedAt": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
allowAutoStopping boolean,null true Determines if apps are auto-paused to save resources.
applicationUrl string,null(uri) true The URL for accessing application endpoints
createdAt string true The timestamp when the application was created
createdBy string,null false The username of who created the application
creatorFirstName string,null false The first name of who created the application
creatorLastName string,null false The last name of who created the application
creatorUserhash string,null false The Gravatar hash of user who created the application
customApplicationSourceId string,null true The custom application source used in app.
customApplicationSourceVersionId string,null true The custom application source version used in app.
envVersionId string,null true The execution environment version used in app
expiresAt string,null(date-time) true ISO-8601 formatted date of the custom application removing date
externalAccessEnabled boolean,null true Determines if sharing with guest users is allowed.
externalAccessRecipients [string] true maxItems: 100
 The external users and domains allowed to view this app.
id string true The Custom Application ID
name string true maxLength: 512
minLength: 1
minLength: 1
 The name of custom application
orgId string,null true ID of creator's organisation
permissions [string] true maxItems: 100
 The list of permitted actions, which the authenticated user can perform on this application.
sourceName string false The name of the custom app source.
sourceVersionLabel string false The label of the source version.
status string true The state of application in LRS
updatedAt string true The timestamp when the application was updated
userId string true Creator's ID

Enumerated Values

Property Value
status [created, failed, initializing, paused, publishing, running]

CustomApplicationCreate

{
  "applicationSourceId": "string",
  "applicationSourceVersionId": "string",
  "environmentId": "string",
  "name": "string",
  "resources": {
    "replicas": 0,
    "resourceLabel": "string",
    "serviceWebRequestsOnRootPath": true,
    "sessionAffinity": true
  }
}

Properties

Name Type Required Restrictions Description
applicationSourceId string false The ID of the custom application source to be used for the new application. The latest version version will be chosen.
applicationSourceVersionId string false The ID of the custom application source version to be used for the new application.
environmentId string false The execution environment ID for the application.
name string,null false maxLength: 512
 The name of the custom application
resources CustomApplicationResources false Resources required for running custom application.

CustomApplicationItemRetrieve

{
  "content": "string",
  "fileName": "string",
  "filePath": "string",
  "id": "string"
}

Properties

Name Type Required Restrictions Description
content string true The textual content of file item.
fileName string true The name of file item.
filePath string true The full internal path of file item.
id string true The file item ID.

CustomApplicationListResponse

{
  "count": 0,
  "data": [
    {
      "allowAutoStopping": true,
      "applicationUrl": "http://example.com",
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "customApplicationSourceId": "string",
      "customApplicationSourceVersionId": "string",
      "envVersionId": "string",
      "expiresAt": "2019-08-24T14:15:22Z",
      "externalAccessEnabled": true,
      "externalAccessRecipients": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "orgId": "string",
      "permissions": [
        "CAN_CHANGE_EXTERNAL_ACCESS"
      ],
      "sourceName": "string",
      "sourceVersionLabel": "string",
      "status": "created",
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [CustomApplication] true maxItems: 100
 An array of custom application objects
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true Number of items across all pages

CustomApplicationLogs

{
  "buildError": "string",
  "buildLog": "string",
  "buildStatus": "string",
  "logs": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
buildError string false The build error of the custom application.
buildLog string false The build log of the custom application.
buildStatus string false The build status of the custom application.
logs [string] true maxItems: 1000
 The logs of the custom application.

CustomApplicationResources

{
  "replicas": 0,
  "resourceLabel": "string",
  "serviceWebRequestsOnRootPath": true,
  "sessionAffinity": true
}

Resources required for running custom application.

Properties

Name Type Required Restrictions Description
replicas integer false minimum: 0
 The number of running application replicas.
resourceLabel string false ID of resource request bundle used for custom application.
serviceWebRequestsOnRootPath boolean,null false Sets whether applications made from this source version expect to receive requests on / or on /apps/{id} by default.
sessionAffinity boolean,null false The Session affinity of an application source version.

CustomApplicationSource

{
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "createdAt": "string",
    "createdBy": "string",
    "creatorFirstName": "string",
    "creatorLastName": "string",
    "creatorUserhash": "string",
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string"
      }
    ],
    "label": "string",
    "updatedAt": "string",
    "userId": "string"
  },
  "name": "string",
  "orgId": "string",
  "permissions": [
    "CAN_PUBLISH_NEW_IMAGE"
  ],
  "updatedAt": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string true The timestamp when the application source was created.
createdBy string,null false The username of who created the application source.
creatorFirstName string,null false The first name of who created the application source.
creatorLastName string,null false The last name of who created the application source.
creatorUserhash string,null false The Gravatar hash of user who created the application source.
id string true The custom application source ID.
latestVersion CustomApplicationSourceVersion true The latest version of the source.
name string true maxLength: 255
minLength: 1
minLength: 1
 The name of the custom application source.
orgId string,null true The ID of the creator's organization.
permissions [string] true maxItems: 100
 The list of permitted actions, which the authenticated user can perform on this application source.
updatedAt string true The timestamp when the application source was modified.
userId string true Creator's ID.

CustomApplicationSourceCreate

{
  "name": "string"
}

Properties

Name Type Required Restrictions Description
name string false maxLength: 255
minLength: 1
minLength: 1
 The name of custom application source.

CustomApplicationSourceFromGalleryTemplateCreate

{
  "customTemplateId": "string"
}

Properties

Name Type Required Restrictions Description
customTemplateId string true The custom template ID for the custom application.

CustomApplicationSourceListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "id": "string",
      "latestVersion": {
        "baseEnvironmentId": "string",
        "baseEnvironmentVersionId": "string",
        "createdAt": "string",
        "createdBy": "string",
        "creatorFirstName": "string",
        "creatorLastName": "string",
        "creatorUserhash": "string",
        "id": "string",
        "isFrozen": true,
        "items": [
          {
            "commitSha": "string",
            "created": "string",
            "fileName": "string",
            "filePath": "string",
            "fileSource": "string",
            "id": "string",
            "ref": "string",
            "repositoryFilePath": "string",
            "repositoryLocation": "string",
            "repositoryName": "string"
          }
        ],
        "label": "string",
        "updatedAt": "string",
        "userId": "string"
      },
      "name": "string",
      "orgId": "string",
      "permissions": [
        "CAN_PUBLISH_NEW_IMAGE"
      ],
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [CustomApplicationSource] true maxItems: 100
 An array of custom application source objects.
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true Number of items across all pages

CustomApplicationSourceUpdate

{
  "name": "string"
}

Properties

Name Type Required Restrictions Description
name string true maxLength: 255
minLength: 1
minLength: 1
 The name of custom application source.

CustomApplicationSourceVersion

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "label": "string",
  "updatedAt": "string",
  "userId": "string"
}

The latest version of the source.

Properties

Name Type Required Restrictions Description
baseEnvironmentId string,null true The ID of the environment used for this source.
baseEnvironmentVersionId string,null true The ID of the environment version used for this source.
createdAt string true The timestamp of when the application source version was created.
createdBy string,null false The username of who created the application source version.
creatorFirstName string,null false The first name of who created the application source version.
creatorLastName string,null false The last name of who created the application source version.
creatorUserhash string,null false The Gravatar hash of user who created the application source version.
id string true The custom application source version ID.
isFrozen boolean true Marks that this version has become immutable.
items [WorkspaceItemResponse] true maxItems: 1000
 List of file items.
label string,null true maxLength: 255
minLength: 1
minLength: 1
 The label of custom application source version.
updatedAt string true The timestamp when the application source version was modified
userId string true Creator's ID.

CustomApplicationSourceVersionCreate

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "baseVersion": "string",
  "file": "string",
  "filePath": "string",
  "filesToDelete": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
baseEnvironmentId string false The base environment to use with this source version.
baseEnvironmentVersionId string false The base environment version ID to use with this source version.
baseVersion string false The ID of the version used as the source for parameter duplication.
file string(binary) false A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file.
filePath any false The local path of the file being uploaded. See the file field explanation for more details.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false maxItems: 1000
 none

continued

Name Type Required Restrictions Description
filesToDelete any false The IDs of the files to be deleted.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false maxItems: 100
 none

continued

Name Type Required Restrictions Description
label string false maxLength: 255
minLength: 1
minLength: 1
 The label for new Custom App Source Version.

CustomApplicationSourceVersionFromCodespace

{
  "codespaceId": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
codespaceId string true ID of the Codespace that should be used as source for files.
label string false maxLength: 255
minLength: 1
minLength: 1
 The label for new Custom App Source Version in case current version is frozen and new should be created.

CustomApplicationSourceVersionFromCodespaceResponse

{
  "id": "string"
}

Properties

Name Type Required Restrictions Description
id string true The custom application source version ID.

CustomApplicationSourceVersionListResponse

{
  "count": 0,
  "data": [
    {
      "baseEnvironmentId": "string",
      "baseEnvironmentVersionId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "id": "string",
      "isFrozen": true,
      "items": [
        {
          "commitSha": "string",
          "created": "string",
          "fileName": "string",
          "filePath": "string",
          "fileSource": "string",
          "id": "string",
          "ref": "string",
          "repositoryFilePath": "string",
          "repositoryLocation": "string",
          "repositoryName": "string"
        }
      ],
      "label": "string",
      "updatedAt": "string",
      "userId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [CustomApplicationSourceVersion] true maxItems: 100
 An array of custom application source version objects.
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true Number of items across all pages

CustomApplicationSourceVersionToCodespace

{
  "codespaceId": "string"
}

Properties

Name Type Required Restrictions Description
codespaceId string true ID of the Codespace that should be used as source for files.

CustomApplicationSourceVersionUpdate

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "file": "string",
  "filePath": "string",
  "filesToDelete": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
baseEnvironmentId string false The base environment to use with this source version.
baseEnvironmentVersionId string false The base environment version ID to use with this source version.
file string(binary) false A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file.
filePath any false The local path of the file being uploaded. See the file field explanation for more details.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false maxItems: 1000
 none

continued

Name Type Required Restrictions Description
filesToDelete any false The IDs of the files to be deleted.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous [string] false maxItems: 100
 none

continued

Name Type Required Restrictions Description
label string false maxLength: 255
minLength: 1
minLength: 1
 The label for new Custom App Source Version.

CustomApplicationUpdate

{
  "allowAutoStopping": true,
  "customApplicationSourceVersionId": "string",
  "externalAccessEnabled": true,
  "externalAccessRecipients": [
    "string"
  ],
  "name": "string"
}

Properties

Name Type Required Restrictions Description
allowAutoStopping boolean false Determines if the custom app should be stopped automatically.
customApplicationSourceVersionId string false The ID of the custom application source version to set this app to.
externalAccessEnabled boolean false Determines if the custom app can be shared with guest users.
externalAccessRecipients [string] false maxItems: 2048
 Who should be able to access the custom app
name string false maxLength: 512
minLength: 1
minLength: 1
 Name of custom application

CustomApplicationsHistoryListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "sourceId": "string",
      "sourceName": "string",
      "sourceVersionId": "string",
      "sourceVersionLabel": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [CustomAppHistory] true maxItems: 100
 The list of custom application soure versions published to this custom application.
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true Number of items across all pages

CustomApplicationsUsagesListResponse

{
  "count": 0,
  "data": [
    {
      "userId": "string",
      "userType": "guest",
      "username": "string",
      "visitTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of items returned on this page
data [CustomAppUsage] true maxItems: 100
 The list of visits to the custom application.
next string,null(uri) true URL pointing to the next page (if null, there is no next page)
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true Number of items across all pages

CustomTemplateCreatePayload

{
  "defaultEnvironment": "string",
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "file": "string",
  "name": "string",
  "templateMetadata": "string",
  "templateSubType": "string",
  "templateType": "string"
}

Properties

Name Type Required Restrictions Description
defaultEnvironment string true Specifies the default environment for the custom metric template.
defaultResourceBundleId string false Specifies the default resource bundle for the custom metric template.
description string true maxLength: 10000
 A description of the custom template.
enabled boolean false Determines whether the template is enabled.
file string(binary) true The file to be used to create the custom metric template.
name string true maxLength: 255
 The name of the custom template.
templateMetadata string,null false Specifies permanent metadata for the custom template.
templateSubType string true maxLength: 255
 Defines sub-type of the custom template.
templateType string true maxLength: 255
 Defines type of the custom template.

Enumerated Values

Property Value
defaultResourceBundleId [cpu.nano, cpu.micro, cpu.small, cpu.medium, cpu.large, cpu.xlarge, cpu.2xlarge, cpu.3xlarge, cpu.4xlarge, cpu.5xlarge, cpu.6xlarge, cpu.7xlarge, cpu.8xlarge, cpu.16xlarge, DRAWSG4dn.xlargeFrac1Regular, DRAWSG4dn.2xlargeFrac1Regular, DRAWSG5.2xlargeFrac1Regular, DRAWSG5.12xlargeFrac1Regular, DRAWSG5.48xlargeFrac1Regular, DRAWSG6e.xlargeFrac1Regular, DRAWSG6e.12xlargeFrac1Regular, DRAWSG6e.48xlargeFrac1Regular, gpu.small, gpu.medium, gpu.large, gpu.xlarge, gpu.2xlarge, gpu.3xlarge, gpu.5xlarge, gpu.7xlarge, starter, basic, basic.8x, train.l, infer.s, infer.m, infer.l]

CustomTemplateEntity

{
  "defaultEnvironment": {
    "environmentId": "string",
    "environmentVersionId": "string"
  },
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "id": "string",
  "items": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "name": "string",
  "templateMetadata": {
    "classLabels": [
      "string"
    ],
    "readme": "string",
    "resourceBundleIds": [
      "string"
    ],
    "source": {},
    "tags": [
      "string"
    ],
    "templateTypeSpecificResources": {
      "serviceWebRequestsOnRootPath": false
    }
  },
  "templateSubType": "string",
  "templateType": "string"
}

Properties

Name Type Required Restrictions Description
defaultEnvironment DefaultEnvironment true Specifies the default environment for the custom template.
defaultResourceBundleId string,null true Specifies the default resource bundle for the custom metric template.
description string true maxLength: 10000
 A description of the custom template.
enabled boolean true Determines whether the template is enabled.
id string true The ID of the custom template.
items [CustomTemplateFile] true maxItems: 1000
 A list of custom files.
name string true maxLength: 255
 The name of the custom template.
templateMetadata TemplateMetadata true Specifies permanent metadata for the custom template.
templateSubType string,null true maxLength: 255
 Defines the type of the custom template.
templateType string true maxLength: 255
 Defines the type of the custom template.

Enumerated Values

Property Value
defaultResourceBundleId [cpu.nano, cpu.micro, cpu.small, cpu.medium, cpu.large, cpu.xlarge, cpu.2xlarge, cpu.3xlarge, cpu.4xlarge, cpu.5xlarge, cpu.6xlarge, cpu.7xlarge, cpu.8xlarge, cpu.16xlarge, DRAWSG4dn.xlargeFrac1Regular, DRAWSG4dn.2xlargeFrac1Regular, DRAWSG5.2xlargeFrac1Regular, DRAWSG5.12xlargeFrac1Regular, DRAWSG5.48xlargeFrac1Regular, DRAWSG6e.xlargeFrac1Regular, DRAWSG6e.12xlargeFrac1Regular, DRAWSG6e.48xlargeFrac1Regular, gpu.small, gpu.medium, gpu.large, gpu.xlarge, gpu.2xlarge, gpu.3xlarge, gpu.5xlarge, gpu.7xlarge, starter, basic, basic.8x, train.l, infer.s, infer.m, infer.l]

CustomTemplateFile

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the custom template file.
name string true maxLength: 255
 Name of the custom template file.

CustomTemplateListResponse

{
  "count": 0,
  "data": [
    {
      "defaultEnvironment": {
        "environmentId": "string",
        "environmentVersionId": "string"
      },
      "defaultResourceBundleId": "cpu.nano",
      "description": "string",
      "enabled": true,
      "id": "string",
      "items": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "name": "string",
      "templateMetadata": {
        "classLabels": [
          "string"
        ],
        "readme": "string",
        "resourceBundleIds": [
          "string"
        ],
        "source": {},
        "tags": [
          "string"
        ],
        "templateTypeSpecificResources": {
          "serviceWebRequestsOnRootPath": false
        }
      },
      "templateSubType": "string",
      "templateType": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [CustomTemplateEntity] true maxItems: 100
 A list of custom templates.
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

CustomTemplateUpdatePayload

{
  "defaultEnvironment": "string",
  "defaultResourceBundleId": "cpu.nano",
  "description": "string",
  "enabled": true,
  "file": "string",
  "name": "string",
  "templateMetadata": "string",
  "templateSubType": "string",
  "templateType": "string"
}

Properties

Name Type Required Restrictions Description
defaultEnvironment string false Specifies the default environment for the custom template.
defaultResourceBundleId string false Specifies the default resource bundle for the custom metric template.
description string false maxLength: 10000
 A description of the custom template.
enabled boolean false Determines whether the template is enabled.
file string(binary) false The file to be used to create the custom template.
name string false maxLength: 255
 The name of the custom template.
templateMetadata string,null false Specifies permanent metadata for the custom template.
templateSubType string false maxLength: 255
 Defines the sub-type of the custom template.
templateType string false maxLength: 255
 Defines the type of the custom template.

Enumerated Values

Property Value
defaultResourceBundleId [cpu.nano, cpu.micro, cpu.small, cpu.medium, cpu.large, cpu.xlarge, cpu.2xlarge, cpu.3xlarge, cpu.4xlarge, cpu.5xlarge, cpu.6xlarge, cpu.7xlarge, cpu.8xlarge, cpu.16xlarge, DRAWSG4dn.xlargeFrac1Regular, DRAWSG4dn.2xlargeFrac1Regular, DRAWSG5.2xlargeFrac1Regular, DRAWSG5.12xlargeFrac1Regular, DRAWSG5.48xlargeFrac1Regular, DRAWSG6e.xlargeFrac1Regular, DRAWSG6e.12xlargeFrac1Regular, DRAWSG6e.48xlargeFrac1Regular, gpu.small, gpu.medium, gpu.large, gpu.xlarge, gpu.2xlarge, gpu.3xlarge, gpu.5xlarge, gpu.7xlarge, starter, basic, basic.8x, train.l, infer.s, infer.m, infer.l]

DefaultEnvironment

{
  "environmentId": "string",
  "environmentVersionId": "string"
}

Specifies the default environment for the custom template.

Properties

Name Type Required Restrictions Description
environmentId string true The ID the environment to use for the public custom metric image.
environmentVersionId string true The ID of the specific environment version to use with the public custom metric image.

GrantAccessControlWithId

{
  "id": "string",
  "role": "string",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the recipient.
role string true The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType string true Describes the recipient type, either user, group, or organization.

Enumerated Values

Property Value
shareRecipientType [user, group, organization]

GrantAccessControlWithUsername

{
  "role": "string",
  "shareRecipientType": "user",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
role string true The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType string true Describes the recipient type, either user, group, or organization.
username string true Username of the user to update the access role for.

Enumerated Values

Property Value
shareRecipientType [user, group, organization]

SharingListV2Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned.
data [AccessControlV2] true maxItems: 1000
 The access control list.
next string,null true URL pointing to the next page.
previous string,null true URL pointing to the previous page.
totalCount integer true Total number of items matching the condition.

TemplateMetadata

{
  "classLabels": [
    "string"
  ],
  "readme": "string",
  "resourceBundleIds": [
    "string"
  ],
  "source": {},
  "tags": [
    "string"
  ],
  "templateTypeSpecificResources": {
    "serviceWebRequestsOnRootPath": false
  }
}

Specifies permanent metadata for the custom template.

Properties

Name Type Required Restrictions Description
classLabels [string] false maxItems: 1000
 List of class names in case of creating a Binary or a multiclass custom model.
readme string,null false maxLength: 1048576
 Content of README.md file of the template.
resourceBundleIds [string] false maxItems: 1000
 Custom template resource bundle ids list.
source TemplateSource false Custom template source repo.
tags [string] false maxItems: 1000
 Custom template tags list.
templateTypeSpecificResources TemplateTypeSpecificResources false Specifies resources for the custom template.

TemplateSource

{}

Custom template source repo.

Properties

None

TemplateTypeSpecificResources

{
  "serviceWebRequestsOnRootPath": false
}

Specifies resources for the custom template.

Properties

Name Type Required Restrictions Description
serviceWebRequestsOnRootPath boolean,null false Whether the 'service_web_requests_on_root_path' resource should be enabled on the custom app.

WorkspaceItemResponse

{
  "commitSha": "string",
  "created": "string",
  "fileName": "string",
  "filePath": "string",
  "fileSource": "string",
  "id": "string",
  "ref": "string",
  "repositoryFilePath": "string",
  "repositoryLocation": "string",
  "repositoryName": "string"
}

Properties

Name Type Required Restrictions Description
commitSha string,null false SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).
created string true ISO-8601 timestamp of when the file item was created.
fileName string true Name of the file item.
filePath string true Path of the file item.
fileSource string true Source of the file item.
id string true ID of the file item.
ref string,null false Remote reference (branch, commit, tag). Branch "master", if not specified.
repositoryFilePath string,null false Full path to the file in the remote repository.
repositoryLocation string,null false URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).
repositoryName string,null false Name of the repository from which the file was pulled.