Projects

Last updated 8 months ago

post
Create project

https://clusterone.com/api
/projects/
Create a new project.
Request
Response
Body Parameters
display_name
required
string
icon
optional
string
color
optional
string
parameters
optional
string
description
optional
string
http_url_to_repo
optional
string
is_public
optional
string
tags
optional
string
201: Created
Project created successfully
{
"id":"21db9a3d-....-40dc4ca1b8d2",
"display_name":"project_name",
"icon":"fa-diamond",
"color":"#92ed55",
"name":"project_name",
"username":"username",
"parameters":null,
"description":"description",
"jobs_count":0,
"http_url_to_repo":null,
"created_by":number,
"members":[
{
"id":number,
"access_level":"owner",
"username":"username",
"photo_url":"https://tensorport-api-development.s3.amazonaws.com/images/empty_image_400_400.png",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"SOm.........mBERs",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-05T13:04:01.920469Z"
}
],
"owner":{
"id":number,
"access_level":"owner",
"username":"username",
"photo_url":"https://tensorport-api-development.s3.amazonaws.com/images/empty_image_400_400.png",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"SOmeLettERsANDnumBERs",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-05T13:04:01.920469Z"
},
"is_public":false,
"created_at":"2018-01-05T14:52:33.588916Z",
"tags":[
],
"commits":null
}

Return list of all user projects. On Clusterone, code repositories are called projects. To create a new project, push an existing Git repository to your account on Clusterone.

get
List projects

https://clusterone.com/api
/projects/
List all projects a user has access to.
Request
Response
Query Parameters
page
optional
string
limit
optional
string
search
optional
string
display_name
optional
string
name
optional
string
description
optional
string
http_url_to_repo
optional
string
created_at
optional
string
owner
optional
string
modified_at
optional
string
200: OK
Projects successfully retrieved
[
{
"id":"21db9a3d-......-40dc4ca1b8d2",
"display_name":"project_name",
"icon":"fa-diamond",
"color":"#92ed55",
"name":"project_name",
"username":"username",
"parameters":null,
"description":"new project",
"jobs_count":0,
"http_url_to_repo":"https://git.tensorport.com/username/project_name.git",
"created_by":number,
"members":[
{
"id":number,
"access_level":null,
"username":"username",
"photo_url":"",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"QA...0XW",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-08T12:22:38.209021Z"
}
],
"owner":{
"id":numer,
"access_level":null,
"username":"username",
"photo_url":"",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"Q....XW",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-08T12:22:38.209021Z"
},
"is_public":false,
"created_at":"2018-01-05T14:52:33.588916Z",
"tags":[
],
"commits":[
]
},
{
"id":"e53df867-ba7a-4041-9da6-f55f31d57d0d",
"display_name":"project_name",
"icon":"fa-institution",
"color":"#e0c706",
"name":"project_name",
"username":"username",
"parameters":null,
"description":"description",
"jobs_count":0,
"http_url_to_repo":"https://git.tensorport.com/username/project_name.git",
"created_by":number,
"members":[
{
"id":number,
"access_level":null,
"username":"username",
"photo_url":"",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"Q...XW",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-08T12:22:38.209021Z"
}
],
"owner":{
"id":number,
"access_level":null,
"username":"username",
"photo_url":"",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"QA....XW",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-08T12:22:38.209021Z"
},
"is_public":false,
"created_at":"2018-01-05T13:10:06.530754Z",
"tags":[
],
"commits":[
]
}
]

get
Details: list

https://clusterone.com/api
/projects/details/:username/:name/
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
Headers
authentication
required
string
Authentication token
200: OK
{
"id":"e53df867-........-f55f31d57d0d",
"display_name":"project_name",
"username":"username",
"icon":"fa-institution",
"color":"#e0c706",
"name":"project_name",
"parameters":null,
"description":"description",
"http_url_to_repo":"https://git.tensorport.com/username/project_name.git",
"git_auth_link":"https://username:password@git.tensorport.com/username/project_name.git",
"parent_repository":null,
"parent_repository_name":null,
"parent_repository_owner":null,
"created_by":number,
"members":[
{
"id":number,
"access_level":"owner",
"username":"username",
"photo_url":"",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"QA......XW",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-08T12:22:38.209021Z"
}
],
"owner":{
"id":number,
"access_level":"owner",
"username":"username",
"photo_url":"",
"email":"username@domain.com",
"first_name":"",
"last_name":"",
"profile_url":"QA......XW",
"date_joined":"2017-07-24T15:15:49Z",
"last_login":"2018-01-08T12:22:38.209021Z"
},
"is_public":false,
"created_at":"2018-01-05T13:10:06.530754Z",
"modified_at":"2018-01-05T13:10:07.211952Z",
"tags":[
],
"commits":[
]
}

delete
Details: delete

https://clusterone.com/api
/projects/details/:username/:name
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
Headers
authentication
required
string
Authentication token
200: OK

patch
Details: patch

https://clusterone.com/api
/projects/details/:username/:name
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
Headers
authentication
required
string
Authentication token
Body Parameters
display_name
optional
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

put
Details: update

https://clusterone.com/api
/projects/details/:username/:name
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
Headers
authentication
required
string
Authentication token
Body Parameters
display_name
optional
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

get
Details ID: list

https://clusterone.com/api
/projects/details_id/:id/
Request
Response
Path Parameters
id
required
int32
Project ID
Headers
authentication
required
string
Authentication token
200: OK

delete
Details ID: delete

https://clusterone.com/api
/projects/details_id/:id/
Request
Response
Path Parameters
id
required
int32
Project ID
Headers
authentication
required
string
Authentication token
200: OK

patch
Details ID: patch

https://clusterone.com/api
/projects/details_id/:id/
Request
Response
Path Parameters
id
required
int32
Project ID
Headers
authentication
required
string
Authentication token
Body Parameters
display_name
optional
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

put
Details ID: update

https://clusterone.com/api
/projects/details_id/:id/
Request
Response
Path Parameters
id
required
int32
Project ID
Headers
authentication
required
string
Authentication token
Body Parameters
display_name
optional
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

get
Add member

https://clusterone.com/api
/projects/:username/:name/add_member/:member_username/:access_level/
Add a member to a project.
Request
Response
Path Parameters
username
required
string
name
required
string
member_username
required
string
access_level
required
string
200: OK

get
Members: confirm

https://clusterone.com/api
/projects/:username/:name/members/:member_username/confirm/
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
member_username
required
string
New project member to confirm
200: OK

get
Members: expire

https://clusterone.com/api
/projects/:username/:name/members/:member_username/expire/
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
member_username
required
string
Project member to expire
200: OK

get
Members: list

https://clusterone.com/api
/projects/:username/:name/members/
Returns a list of members of a project
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
200: OK

get
Members: read

https://clusterone.com/api
/projects/:username/:name/members/:member_username
Returns information about a specific member of a project
Request
Response
Path Parameters
username
required
string
Owner of the project
name
required
string
Name of the project
member_username
required
string
Name of the member to get information about
200: OK

post
Owned: create

https://clusterone.com/api
/projects/owned
Request
Response
Body Parameters
display_name
required
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

get
Owned: list

https://clusterone.com/api
/projects/owned
List projects owned by current user.
Request
Response
Query Parameters
page
optional
string
limit
optional
string
search
optional
string
display_name
optional
string
name
optional
string
description
optional
string
http_url_to_repo
optional
string
created_at
optional
string
owner
optional
string
modified_at
optional
string
200: OK

get
Read owner

https://clusterone.com/api
/projects/:username/:name/owner/:member_username
Request
Response
Path Parameters
username
required
string
name
required
string
member_username
required
string
200: OK

get
Read public details

https://clusterone.com/api
/projects/public_details/:username/:name/
Request
Response
Path Parameters
username
required
string
name
required
string
200: OK

post
Readable: create

https://clusterone.com/api
/projects/readable/
Request
Response
Body Parameters
display_name
required
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

get
Readable: list

https://clusterone.com/api
/projects/readable/
Request
Response
Query Parameters
page
optional
string
limit
optional
string
search
optional
string
display_name
optional
string
name
optional
string
description
optional
string
http_url_to_repo
optional
string
created_at
optional
string
owner
optional
string
modified_at
optional
string
200: OK

post
Writeable: create

https://clusterone.com/api
/projects/writable/
Request
Response
Body Parameters
display_name
required
string
icon
optional
string
color
optional
string
full_name
optional
string
parameters
optional
string
description
optional
string
parent_repository
optional
string
is_public
optional
string
tags
optional
string
source
optional
string
200: OK

get
Writable: list

https://clusterone.com/api
/projects/writable/
Request
Response
Query Parameters
page
optional
string
limit
optional
string
search
optional
string
display_name
optional
string
name
optional
string
description
optional
string
http_url_to_repo
optional
string
created_at
optional
string
owner
optional
string
modified_at
optional
string
200: OK