Deployments
Deployments let the user schedule a job to deploy the contents of their workspace repository to their workspace in the Matatika cloud.
This can be done manually or via a GitHub Webhook which you can see how to set up in our Quick Start Guide: Workspace Deploy Hook
Requests
Deploy your workspace repository
POST
/api/workspaces/{workspaces-id}/deployments
Deploys the workspace {workspace-id}.
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/9cc1738f-c1e0-486d-b1cb-cff00cd58826/deployments' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://app.matatika.com/api/workspaces/9cc1738f-c1e0-486d-b1cb-cff00cd58826/deployments"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
202 Accepted
Job with HAL links.
{
"id" : "94150a1c-0850-4c55-9881-094fd2a04589",
"created" : "2025-01-17T16:57:28.906023",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@sit+prod",
"email" : "[email protected]"
}
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/jobs/94150a1c-0850-4c55-9881-094fd2a04589"
},
"delete job" : {
"href" : "https://app.matatika.com/api/jobs/94150a1c-0850-4c55-9881-094fd2a04589",
"type" : "DELETE"
},
"logs" : {
"href" : "https://app.matatika.com/api/jobs/94150a1c-0850-4c55-9881-094fd2a04589/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://app.matatika.com/api/jobs/94150a1c-0850-4c55-9881-094fd2a04589/stopped",
"type" : "PUT"
}
}
}
GitHub webhook workspace deployment
POST
/api/workspaces/{workspaces-id}/deployments/github-webhook
Receives POST requests from GitHub and starts a workspace deploy job.
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/9cc1738f-c1e0-486d-b1cb-cff00cd58826/deployments/github-webhook' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'X-Hub-Signature: sha1=9dc2ba22a77a53c6ca32d24f9d3cad661ec92a64' \
-H 'Content-Type: application/json' \
-d '{ }'
Python (requests)
import requests
url = "https://app.matatika.com/api/workspaces/9cc1738f-c1e0-486d-b1cb-cff00cd58826/deployments/github-webhook"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
202 Accepted
Job with HAL links.
{
"id" : "a75bd1d5-6ad4-40c5-96b2-0963cf9c1240",
"created" : "2025-01-17T16:57:30.165134",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@sit+prod",
"email" : "[email protected]"
}
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/jobs/a75bd1d5-6ad4-40c5-96b2-0963cf9c1240"
},
"delete job" : {
"href" : "https://app.matatika.com/api/jobs/a75bd1d5-6ad4-40c5-96b2-0963cf9c1240",
"type" : "DELETE"
},
"logs" : {
"href" : "https://app.matatika.com/api/jobs/a75bd1d5-6ad4-40c5-96b2-0963cf9c1240/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://app.matatika.com/api/jobs/a75bd1d5-6ad4-40c5-96b2-0963cf9c1240/stopped",
"type" : "PUT"
}
}
}