Functions

get
Get List of Functions

https://sharedcloud.io/api/v1/functions/
This endpoint allows you to get the list of functions
Request
Response
Headers
Authorization
required
string
Authentication token
200: OK
List of functions successfully retrieved.
[
{
"uuid": "8b9420da-a848-4523-a138-ddbf33007631",
"current_server_time": "05-10-2018 14:51:12",
"registry_path": "sharedcloud/tensorflow-gpu-python36:latest",
"runtime": "python36",
"num_runs": 1,
"updated_at": "05-10-2018 13:18:53",
"created_at": "05-10-2018 13:18:53",
"name": "mnist",
"code": "...",
"image": "23ca880b-94fe-472c-b9cf-934ed8295872"
}
]
401: Unauthorized
Invalid credentials.
{
"detail": "Invalid token."
}

get
Get Function

https://sharedcloud.io/api/v1/functions/:uuid/
This endpoint allows you to get a single function
Request
Response
Path Parameters
uuid
required
string
uuid of the function
Headers
Authorization
required
string
Authentication token
200: OK
Function successfully retrieved.
{
"uuid": "8b94207a-a878-4523-a138-ddc733077131",
"current_server_time": "05-10-2018 14:51:12",
"registry_path": "sharedcloud/tensorflow-gpu-python36:latest",
"runtime": "python36",
"num_runs": 1,
"updated_at": "05-10-2018 13:18:53",
"created_at": "05-10-2018 13:18:53",
"name": "mnist",
"code": "...",
"image": "23ca880b-94fe-472c-b9cf-934ed8295872"
}
401: Unauthorized
Invalid credentials.
{
"detail": "Invalid token."
}
404: Not Found
Function not found.
{
"detail": "Not found."
}

post
Create Function

https://sharedcloud.io/api/v1/functions/
This endpoint allows you to create a function
Request
Response
Headers
Authorization
required
string
Authentication token
Body Parameters
code
required
string
code of the function
runtime
required
string
runtime of the function
image
required
string
UUID of the image
name
required
string
name of the function
200: OK
Function successfully created.
{
"uuid": "8b94207a-a878-4523-a128-ddc732077131",
"current_server_time": "05-10-2018 14:51:12",
"registry_path": "sharedcloud/tensorflow-gpu-python36:latest",
"runtime": "python36",
"num_runs": 1,
"updated_at": "05-10-2018 13:18:53",
"created_at": "05-10-2018 13:18:53",
"name": "mnist",
"code": "...",
"image": "23ca880b-94fe-472c-b9cf-934ed8295872"
}
401: Unauthorized
Invalid credentials.
{
"detail": "Invalid token."
}

put
Update Function

https://sharedcloud.io/api/v1/functions/:uuid/
This endpoint allows you to update a function
Request
Response
Path Parameters
uuid
required
string
UUID of the function
Headers
Authorization
required
string
Authentication token
Body Parameters
code
required
string
code of the function
runtime
required
string
runtime of the function
image
required
string
UUID of the image
name
required
string
name of the function
200: OK
Function successfully updated.
{
"uuid": "8b94207a-a878-4523-a138-ddc733077131",
"current_server_time": "05-10-2018 14:51:12",
"registry_path": "sharedcloud/tensorflow-gpu-python36:latest",
"runtime": "python36",
"num_runs": 1,
"updated_at": "05-10-2018 13:18:53",
"created_at": "05-10-2018 13:18:53",
"name": "mnist",
"code": "...",
"image": "23ca880b-94fe-472c-b9cf-934ed8295872"
}
401: Unauthorized
Invalid credentials.
{
"detail": "Invalid token."
}
404: Not Found
Function not found.
{
"detail": "Not found."
}

patch
Partially update Function

https://sharedcloud.io/api/v1/functions/:uuid/
This endpoint allows you to partially update a function
Request
Response
Path Parameters
uuid
required
string
UUID of the function
Headers
Authorization
required
string
Authentication token
Body Parameters
code
optional
string
code of the function
runtime
optional
string
runtime of the function
image
optional
string
UUID of the image
name
optional
string
name of the function
200: OK
Function partially updated successfully.
{
"uuid": "8b94207a-a878-4523-a138-ddc733077131",
"current_server_time": "05-10-2018 14:51:12",
"registry_path": "sharedcloud/tensorflow-gpu-python36:latest",
"runtime": "python36",
"num_runs": 1,
"updated_at": "05-10-2018 13:18:53",
"created_at": "05-10-2018 13:18:53",
"name": "mnist",
"code": "...",
"image": "23ca880b-94fe-472c-b9cf-934ed8295872"
}
401: Unauthorized
Invalid credentials.
{
"detail": "Invalid token."
}
404: Not Found
Function not found
{
"detail": "Not found."
}

delete
Delete Function

https://sharedcloud.io/api/v1/functions/:uuid/
This endpoint allows you to delete a function
Request
Response
Path Parameters
uuid
required
string
uuid of the function
Headers
Authorization
required
string
Authentication token
200: OK
Function deleted successfully.
{}
401: Unauthorized
Invalid credentials.
{
"detail": "Invalid token."
}
404: Not Found
Function not found
{
"detail": "Not found."
}