DataRobot API resources > API reference documentation > DataRobot REST API > Applications > Application templates

Application Templates¶

This page outlines the operations, endpoints, parameters, and example requests and responses for the Application Templates.

GET /api/v2/applicationTemplates/¶

List application templates the user has access to.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/applicationTemplates/ \
  -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.

Example responses¶

200 Response


{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "description": "string",
      "editedAt": "string",
      "editedBy": "string",
      "editorFirstName": "string",
      "editorLastName": "string",
      "editorUserhash": "string",
      "id": "string",
      "isGlobal": true,
      "isPremium": true,
      "mediaUrl": "http://example.com",
      "name": "string",
      "readme": "string",
      "repository": {
        "isPublic": true,
        "tag": "string",
        "url": "http://example.com"
      },
      "tags": [
        "string"
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ApplicationTemplateListResponse

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

BearerAuth

POST /api/v2/applicationTemplates/¶

Create an application template.

Code samples¶


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

Body parameter¶


{
  "description": "string",
  "media": "string",
  "name": "string",
  "readme": "string",
  "repository": "string",
  "tags": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApplicationTemplateCreate	false	none

Responses¶

Status	Meaning	Description	Schema
201	Created	none	None
403	Forbidden	Permission settings do not allow creating templates.	None

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

BearerAuth

DELETE /api/v2/applicationTemplates/{applicationTemplateId}/¶

Delete an application template.

Code samples¶


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

Parameters

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

Responses¶

Status	Meaning	Description	Schema
204	No Content	none	None
403	Forbidden	Permission settings do not allow deleting templates.	None
404	Not Found	The template is either global, preventing deletion, or does not exist.	None

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

BearerAuth

PATCH /api/v2/applicationTemplates/{applicationTemplateId}/¶

Update an application template.

Code samples¶


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

Body parameter¶


{
  "description": "string",
  "name": "string",
  "readme": "string",
  "repository": "string",
  "tags": "string"
}

Parameters

Name	In	Type	Required	Description
applicationTemplateId	path	string	true	The ID of the template.
body	body	ApplicationTemplateUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	none	None
403	Forbidden	Permission settings do not allow updating templates.	None
404	Not Found	The template is either global, preventing updates, or does not exist.	None

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

BearerAuth

POST /api/v2/applicationTemplates/{applicationTemplateId}/clone/¶

Clone an application template into a codespace.

Code samples¶


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

Parameters

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

Example responses¶

200 Response


{
  "notebookId": "string",
  "useCaseId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ApplicationTemplateCloneResponse
403	Forbidden	Permission settings do not allow cloning templates.	None
404	Not Found	The template does not exist.	None
422	Unprocessable Entity	An error ocurred when creating the codespace.	None

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

BearerAuth

DELETE /api/v2/applicationTemplates/{applicationTemplateId}/media/¶

Delete an application template image/gif.

Code samples¶


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

Parameters

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

Responses¶

Status	Meaning	Description	Schema
204	No Content	none	None
403	Forbidden	Permission settings do not allow allow deleting media from templates.	None
404	Not Found	The template is either global, preventing media deletion, or does not exist.	None

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

BearerAuth

GET /api/v2/applicationTemplates/{applicationTemplateId}/media/¶

Retrieve an application template image.

Code samples¶


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

Parameters

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

Example responses¶

200 Response


{
  "data": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ApplicationTemplateMediaResponse
404	Not Found	The template media does not exist or the template does not exist.	None

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

BearerAuth

POST /api/v2/applicationTemplates/{applicationTemplateId}/media/¶

Upload an application template image/gif.

Code samples¶


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

Body parameter¶


{
  "media": "string"
}

Parameters

Name	In	Type	Required	Description
applicationTemplateId	path	string	true	The ID of the template.
body	body	ApplicationTemplateMediaUpload	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	none	None
403	Forbidden	Permission settings do not allow allow uploading media to templates.	None
404	Not Found	The template is either global, preventing media upload, or does not exist.	None

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

BearerAuth

Schemas¶

ApplicationTemplateCloneResponse


{
  "notebookId": "string",
  "useCaseId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
notebookId	string	true		The ID of the newly created codespace.
useCaseId	string	true		The ID of the newly created Use Case.

ApplicationTemplateCreate


{
  "description": "string",
  "media": "string",
  "name": "string",
  "readme": "string",
  "repository": "string",
  "tags": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string	true		A short description of the template.
media	string(binary)	false		An image (.png, .jpg, .svg, .gif) that is displayed alongside the template.
name	string	true	maxLength: 256	The name of the template.
readme	string(binary)	true		A long-form Markdown readme to be included with the template.
repository	string	true		The repository the template is stored in.
tags	string	true	maxLength: 256	All tags of the repository.

ApplicationTemplateListResponse


{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "creatorFirstName": "string",
      "creatorLastName": "string",
      "creatorUserhash": "string",
      "description": "string",
      "editedAt": "string",
      "editedBy": "string",
      "editorFirstName": "string",
      "editorLastName": "string",
      "editorUserhash": "string",
      "id": "string",
      "isGlobal": true,
      "isPremium": true,
      "mediaUrl": "http://example.com",
      "name": "string",
      "readme": "string",
      "repository": {
        "isPublic": true,
        "tag": "string",
        "url": "http://example.com"
      },
      "tags": [
        "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	[ApplicationTemplateResponse]	true	maxItems: 100	The list of 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.

ApplicationTemplateMediaResponse


{
  "data": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
data	string(binary)	true		The media file returned as a FileObject.

ApplicationTemplateMediaUpload


{
  "media": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
media	string(binary)	true		An image (.png, .jpg, .svg, .gif) that is displayed alongside the template.

ApplicationTemplateResponse


{
  "createdAt": "string",
  "createdBy": "string",
  "creatorFirstName": "string",
  "creatorLastName": "string",
  "creatorUserhash": "string",
  "description": "string",
  "editedAt": "string",
  "editedBy": "string",
  "editorFirstName": "string",
  "editorLastName": "string",
  "editorUserhash": "string",
  "id": "string",
  "isGlobal": true,
  "isPremium": true,
  "mediaUrl": "http://example.com",
  "name": "string",
  "readme": "string",
  "repository": {
    "isPublic": true,
    "tag": "string",
    "url": "http://example.com"
  },
  "tags": [
    "string"
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
createdAt	string,null	true		The ISO timestamp indicating when the template was created.
createdBy	string,null	true		The user who created the template.
creatorFirstName	string,null	true		The first name of the user who created the template.
creatorLastName	string,null	true		The last name of the user who created the template.
creatorUserhash	string,null	false		The Gravatar hash of the user who created the template.
description	string	true		A short description of the template.
editedAt	string,null	true		The ISO timestamp indicating when the template was last edited.
editedBy	string,null	true		The user who last edited the template.
editorFirstName	string,null	true		The first name of the user who last edited the template.
editorLastName	string,null	true		The last name of the user who last edited the template.
editorUserhash	string,null	true		The Gravatar hash of the user who last edited the template.
id	string	true		The ID of the template.
isGlobal	boolean	true		Whether the template is a global template created by DataRobot.
isPremium	boolean,null	true		Whether the template is a premium template.
mediaUrl	string,null(uri)	true		A link to the media URL if there is media associated with the application.
name	string	true	maxLength: 256	The name of the template.
readme	string	true	maxLength: 256000	A long-form Markdown readme to be included with the template.
repository	Repository	true		The repository the template is stored in.
tags	[string]	true	maxItems: 256	All tags of the repository.

ApplicationTemplateUpdate


{
  "description": "string",
  "name": "string",
  "readme": "string",
  "repository": "string",
  "tags": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string	false		A short description of the template.
name	string	false	maxLength: 256	The name of the template.
readme	string(binary)	false		A long-form Markdown readme to be included with the template.
repository	string	false		The repository the template is stored in.
tags	string	false	maxLength: 256	All tags of the repository.

Repository


{
  "isPublic": true,
  "tag": "string",
  "url": "http://example.com"
}

The repository the template is stored in.

Properties¶

Name	Type	Required	Restrictions	Description
isPublic	boolean	true		Sets whether the repository is public or requires authentication.
tag	string	true	maxLength: 256	A reference pointing to where to check out the repository, from either a branch or a commit SHA.
url	string(uri)	true		The URL to the github repository (e.g. https://github.com/my-org/my-project/).

Application Templates¶

GET /api/v2/applicationTemplates/¶

Code samples¶

Parameters

Example responses¶

Responses¶

POST /api/v2/applicationTemplates/¶

Code samples¶

Body parameter¶

Parameters

Responses¶

DELETE /api/v2/applicationTemplates/{applicationTemplateId}/¶

Code samples¶

Parameters

Responses¶

PATCH /api/v2/applicationTemplates/{applicationTemplateId}/¶

Code samples¶

Body parameter¶

Parameters

Responses¶

POST /api/v2/applicationTemplates/{applicationTemplateId}/clone/¶

Code samples¶

Parameters

Example responses¶

Responses¶

DELETE /api/v2/applicationTemplates/{applicationTemplateId}/media/¶

Code samples¶

Parameters

Responses¶

GET /api/v2/applicationTemplates/{applicationTemplateId}/media/¶

Code samples¶

Parameters

Example responses¶

Responses¶

POST /api/v2/applicationTemplates/{applicationTemplateId}/media/¶

Code samples¶

Body parameter¶

Parameters

Responses¶

Schemas¶

ApplicationTemplateCloneResponse

Properties¶

ApplicationTemplateCreate

Properties¶

ApplicationTemplateListResponse

Properties¶

ApplicationTemplateMediaResponse

Properties¶

ApplicationTemplateMediaUpload

Properties¶

ApplicationTemplateResponse

Properties¶

ApplicationTemplateUpdate

Properties¶

Repository

Properties¶

Was this page helpful?

Great! Let us know what you found helpful.

What can we do to improve the content?