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" : "312fd21b-1f53-4321-b6cc-bb81792a499a",
  "created" : "2025-05-02T08:52:43.008455",
  "lastModified" : "2025-05-02T08:52:43.008456",
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027)",
  "clientId" : "LthoUS52BzNSmGrhYYwa44KL1Y6e0pLb",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "profile" : {
      "href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

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/api/apikeys/' -i -X GET \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/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" : "a81e0928-5c47-4956-b7e1-0be56af0a051",
      "created" : "2025-05-02T08:52:41.906185",
      "lastModified" : "2025-05-02T08:52:41.906186",
      "name" : "default",
      "clientId" : "1dX0ELXASRf2eUxg8vdfAn1MXCndnV0b",
      "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
      "accessToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJFRkNRamczTlRRMk16QTROalpHT0RjNFFUWkJOemMyTkRGR1FUSkVOVEEyUkRkR1JrSkRPQSJ9.eyJpc3MiOiJodHRwczovL2lkZW50aXR5Lm1hdGF0aWthLmNvbS8iLCJzdWIiOiIxZFgwRUxYQVNSZjJlVXhnOHZkZkFuMU1YQ25kblYwYkBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hcHAubWF0YXRpa2EuY29tL2FwaSIsImlhdCI6MTc0NjE3NTk2MiwiZXhwIjoxNzQ2MjYyMzYyLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiIxZFgwRUxYQVNSZjJlVXhnOHZkZkFuMU1YQ25kblYwYiJ9.IlinJ6lg_miqze6Ig0lTnsEok82BlciILz1vpZNei_i46uGv5YcNutqf7mTp_ISMzzHXfmK3j3nYI2NIikkO1eAxaQjcUOqWDLbsBEFSzwIJSVBs7Fcm0zientq3xr4YNDLg-EI2bH_4UQ7NoVvtKgcC3Dn0dxmgWoyj2lPASxF9F_5bdZ1Z5j9rzbcrNwM5yxv76x8T4niWwUxNfKis-aKXfGV5cYG7JnopjrWCWwlIe9OjL0wHYYg7FfVUcaeP2_9i7fDHyPghKGcoeoG6W5mANhugkFMKDKZudjM0vcoyOzElqqGn9AzU75uw4wVZiBVZKOHpBsco0Cqk0FztrA",
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/apikeys/a81e0928-5c47-4956-b7e1-0be56af0a051"
        },
        "update apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/a81e0928-5c47-4956-b7e1-0be56af0a051"
        },
        "delete apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/a81e0928-5c47-4956-b7e1-0be56af0a051"
        },
        "profile" : {
          "href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
        }
      }
    }, {
      "id" : "312fd21b-1f53-4321-b6cc-bb81792a499a",
      "created" : "2025-05-02T08:52:43.008455",
      "lastModified" : "2025-05-02T08:52:43.008456",
      "name" : "SIT-generated api key (2025-05-02T09:52:42.959027)",
      "clientId" : "LthoUS52BzNSmGrhYYwa44KL1Y6e0pLb",
      "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
        },
        "update apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
        },
        "delete apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
        },
        "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/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a' -i -X GET \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"

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" : "312fd21b-1f53-4321-b6cc-bb81792a499a",
  "created" : "2025-05-02T08:52:43.008455",
  "lastModified" : "2025-05-02T08:52:43.008456",
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027)",
  "clientId" : "LthoUS52BzNSmGrhYYwa44KL1Y6e0pLb",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "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/api/apikeys/' -i -X POST \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/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" : "312fd21b-1f53-4321-b6cc-bb81792a499a",
  "created" : "2025-05-02T08:52:42.92784771",
  "lastModified" : "2025-05-02T08:52:42.92784821",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "create apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    }
  }
}

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-05-02T09:52:42.959027)"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027)"
}'

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"

data = {
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027)"
}
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" : "312fd21b-1f53-4321-b6cc-bb81792a499a",
  "created" : "2025-05-02T08:52:43.0084553",
  "lastModified" : "2025-05-02T08:52:43.0084562",
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027)",
  "clientId" : "LthoUS52BzNSmGrhYYwa44KL1Y6e0pLb",
  "clientSecret" : "CNZPfHhjeuJn9M_FJX9pqTbSQL7foUI36sm7TqEdmnvyaBFM3WiMe5m7CnhzNm6d",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "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-05-02T09:52:42.959027) (updated)"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027) (updated)"
}'

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"

data = {
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027) (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" : "312fd21b-1f53-4321-b6cc-bb81792a499a",
  "created" : "2025-05-02T08:52:43.008455",
  "lastModified" : "2025-05-02T08:52:43.960641783",
  "name" : "SIT-generated api key (2025-05-02T09:52:42.959027) (updated)",
  "clientId" : "LthoUS52BzNSmGrhYYwa44KL1Y6e0pLb",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"
    },
    "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/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a' -i -X DELETE \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/312fd21b-1f53-4321-b6cc-bb81792a499a"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.