API Keys
API keys offer an alternate method of authentication to the Matatika API using a client ID and secret. Access using API key credentials is supported by the Matatika CLI and SDK, which allows a user to remain authenticated permanently.
Objects
API Key
Path | JSON Type | Format | Description |
---|---|---|---|
id |
string |
Version 4 UUID | The API key ID |
created |
string |
ISO 8601 timestamp | The instant when the API key was created |
lastModified |
string |
ISO 8601 timestamp | The instant when the API key was last modified |
name |
string |
The API key name | |
clientId |
string |
The API key client ID | |
profileId |
string |
The API key owner profile ID |
{
"id" : "a453be80-7faa-4096-9b1a-d3d6fe4a3816",
"created" : "2025-06-19T10:15:47.661062",
"lastModified" : "2025-06-19T10:15:47.661062",
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)",
"clientId" : "Q75PbDfy7GsDgPthZe8kMxbDxSDiJE0u",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Requests
- View all API keys
- View an API key
- Initialise an API key
- Create an API key
- Update an API key
- Delete an API key
View all API keys
GET
/api/apikeys
Returns all API keys owned by the authenticated user profile.
Prerequisites
- The authenticated user must own a Matatika account
- The API key
{apikey-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/apikeys/' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/apikeys/"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
API key collection with HAL links.
{
"_embedded" : {
"apikeys" : [ {
"id" : "aeb149f8-41dd-4b14-9cbd-0c64cb784122",
"created" : "2025-06-19T10:15:46.476755",
"lastModified" : "2025-06-19T10:15:46.476756",
"name" : "default",
"clientId" : "kThoJrmZia0fztb5zAIQIqplZqAX8Pn2",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"accessToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJFRkNRamczTlRRMk16QTROalpHT0RjNFFUWkJOemMyTkRGR1FUSkVOVEEyUkRkR1JrSkRPQSJ9.eyJpc3MiOiJodHRwczovL2lkZW50aXR5Lm1hdGF0aWthLmNvbS8iLCJzdWIiOiJrVGhvSnJtWmlhMGZ6dGI1ekFJUUlxcGxacUFYOFBuMkBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hcHAubWF0YXRpa2EuY29tL2FwaSIsImlhdCI6MTc1MDMyODE0NywiZXhwIjoxNzUwNDE0NTQ3LCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJrVGhvSnJtWmlhMGZ6dGI1ekFJUUlxcGxacUFYOFBuMiJ9.LVxf2FYzdSkqZx1zqywTRzEIavx2Zf9uTjFbQ9a82ga22AL_0J8OshcRfmjZk_PKbs8J1DCppgV6mRT9RXchBUvAmnGPDXvJ-1iIyk86b6jhPcvo6Zlq6w38BhtWW4c5lgaZiXk20rQv2QoCx_V_RlrDII3GwDxBARmaXAF9SKBDhtiDAXHXltHQ3B9s8zu1x6BakoPVcZsM6s9DUR5q1x4xou1V5a7AKfmCOKelzf5L-bybCAcYMFWqVnfESMjv3nZbIqJgCDSRah4msM-eGgqlXfGXFceuoSgoQ7Cc5Vr7PkUgP9Rq3Wi8qlL3ZPVfH-sWU-6wTZwOAO4gGXARnQ",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/aeb149f8-41dd-4b14-9cbd-0c64cb784122"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/aeb149f8-41dd-4b14-9cbd-0c64cb784122"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/aeb149f8-41dd-4b14-9cbd-0c64cb784122"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}, {
"id" : "a453be80-7faa-4096-9b1a-d3d6fe4a3816",
"created" : "2025-06-19T10:15:47.661062",
"lastModified" : "2025-06-19T10:15:47.661062",
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)",
"clientId" : "Q75PbDfy7GsDgPthZe8kMxbDxSDiJE0u",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
View an API key
GET
/api/apikeys/{apikey-id}
Returns the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
- The API key
{apikey-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
API key with HAL links.
{
"id" : "a453be80-7faa-4096-9b1a-d3d6fe4a3816",
"created" : "2025-06-19T10:15:47.661062",
"lastModified" : "2025-06-19T10:15:47.661062",
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)",
"clientId" : "Q75PbDfy7GsDgPthZe8kMxbDxSDiJE0u",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Initialise an API key
POST
/api/apikeys
Initialises a new API key.
Prerequisites
- The authenticated user must own a Matatika account
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/apikeys/' -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:443/api/apikeys/"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
API key with HAL links.
{
"id" : "a453be80-7faa-4096-9b1a-d3d6fe4a3816",
"created" : "2025-06-19T10:15:47.547149586",
"lastModified" : "2025-06-19T10:15:47.547151586",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"create apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
}
}
}
Create an API key
PUT
/api/apikeys/{apikey-id}
Creates the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
Request
Body
API key resource.
{
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)"
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)"
}'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
data = {
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
201 Created
API key with HAL links.
{
"id" : "a453be80-7faa-4096-9b1a-d3d6fe4a3816",
"created" : "2025-06-19T10:15:47.661061725",
"lastModified" : "2025-06-19T10:15:47.661062425",
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378)",
"clientId" : "Q75PbDfy7GsDgPthZe8kMxbDxSDiJE0u",
"clientSecret" : "hI2xtqmoeDxPZCnDKzMJx9RBOGjy6Gs--1k8RQhr_XgPuHS39yKP4XoTuniSA-eb",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Update an API key
PUT
/api/apikeys/{apikey-id}
Updates the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
Request
Body
API key resource.
{
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378) (updated)"
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378) (updated)"
}'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
data = {
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378) (updated)"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
API key with HAL links.
{
"id" : "a453be80-7faa-4096-9b1a-d3d6fe4a3816",
"created" : "2025-06-19T10:15:47.661062",
"lastModified" : "2025-06-19T10:15:48.536234796",
"name" : "SIT-generated api key (2025-06-19T11:15:47.593378) (updated)",
"clientId" : "Q75PbDfy7GsDgPthZe8kMxbDxSDiJE0u",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Delete an API key
DELETE
/api/apikeys/{apikey-id}
Deletes the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
- The API key
{apikey-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/apikeys/a453be80-7faa-4096-9b1a-d3d6fe4a3816"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.