Api keys

Manage API keys. Only from the dashboard, so a leaked key cannot mint new ones.

List API keys

GET/v1/api-keysDashboard only

Response 200

data []

• idstringrequired
• namestringrequired
• prefixstringrequired
• createdAtstring (date-time)required
• revokedAtstring (date-time)

curl

curl "https://api.marsial.dev/v1/api-keys" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/api-keys', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/api-keys",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Create an API key

POST/v1/api-keysDashboard only

Body

• namestringrequired

  max 60

Response 201

data

• keyobjectrequired
  key

  • idstringrequired
  • namestringrequired
  • prefixstringrequired
  • createdAtstring (date-time)required
  • revokedAtstring (date-time)
• secretstringrequired

  The full key, shown only this once.

curl

curl -X POST "https://api.marsial.dev/v1/api-keys" \
  -H "Authorization: Bearer $MARSIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production"
  }'

Node

const res = await fetch('https://api.marsial.dev/v1/api-keys', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "production"
  }),
});
const { data } = await res.json();

Python

import os, requests

res = requests.post(
    "https://api.marsial.dev/v1/api-keys",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
    json={
        "name": "production"
    },
)
data = res.json()["data"]

Revoke an API key

DELETE/v1/api-keys/{id}Dashboard only

Parameters

• idstringrequired

Response 204

No content

curl

curl -X DELETE "https://api.marsial.dev/v1/api-keys/key_2b4n6m" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

await fetch('https://api.marsial.dev/v1/api-keys/key_2b4n6m', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});

Python

import os, requests

requests.delete(
    "https://api.marsial.dev/v1/api-keys/key_2b4n6m",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)