Back to Top

Catalogist

1.0.0

Catalogist is the easy way to catalog and make your software and (micro)services visible to your organization in a lightweight and developer-friendly way.

This is the documentation for version 1.0.0 of the API. Last update on Jan 12, 2022.

Base URL
https://RANDOM.execute-api.REGION.amazonaws.com/shared

Send an authentication token in the Authorization header to authenticate with the API.


Create record

POST /record

Create record

Body Required

Create record request body

Responses
  • default string

    Forbidden

  • 204

    Successful response

  • 401 string

    Unauthorized

  • 403 string

    Forbidden

  • 404 string

    Not found

  • 406 string

    Not acceptable

  • 429 string

    Too many requests

POST /record
curl \
 -X POST https://RANDOM.execute-api.REGION.amazonaws.com/shared/record \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"spec":{"serviceName":"string","serviceType":"string","lifecycleStage":"string","version":"string","description":"string","responsible":"string","team":"string","system":"string","domain":"string","dataSensitivity":"string","tags":["string"]},"support":{},"slo":[{"description":"string","level":"string","percentile":"string","maxLatency":"string"}],"api":[{"serviceName":"string"}],"metadata":{},"links":[{"url":"string","title":"string","icon":"string"}]}'
Request example
{
  "spec": {
    "serviceName": "string",
    "serviceType": "string",
    "lifecycleStage": "string",
    "version": "string",
    "description": "string",
    "responsible": "string",
    "team": "string",
    "system": "string",
    "domain": "string",
    "dataSensitivity": "string",
    "tags": [
      "string"
    ]
  },
  "support": {},
  "slo": [
    {
      "description": "string",
      "level": "string",
      "percentile": "string",
      "maxLatency": "string"
    }
  ],
  "api": [
    {
      "serviceName": "string"
    }
  ],
  "metadata": {},
  "links": [
    {
      "url": "string",
      "title": "string",
      "icon": "string"
    }
  ]
}
Response example (default)
"Forbidden"
Response example (401)
"Unauthorized"
Response example (403)
"Forbidden"
Response example (404)
"Not found"
Response example (406)
"Not acceptable"
Response example (429)
"Too many requests"

Get records

GET /records

Get records

Query parameters
Responses
GET /records
curl \
 -X GET https://RANDOM.execute-api.REGION.amazonaws.com/shared/records \
 -H "Authorization: $API_KEY"
Response example (default)
"Unauthorized"
Response example (200)
{
  "spec": {
    "serviceName": "string",
    "serviceType": "string",
    "lifecycleStage": "string",
    "version": "string",
    "description": "string",
    "responsible": "string",
    "team": "string",
    "system": "string",
    "domain": "string",
    "dataSensitivity": "string",
    "tags": [
      "string"
    ]
  },
  "support": {},
  "slo": [
    {
      "description": "string",
      "level": "string",
      "percentile": "string",
      "maxLatency": "string"
    }
  ],
  "api": [
    {
      "serviceName": "string"
    }
  ],
  "metadata": {},
  "links": [
    {
      "url": "string",
      "title": "string",
      "icon": "string"
    }
  ]
}
Response example (401)
"Unauthorized"
Response example (403)
"Forbidden"
Response example (404)
"Not found"
Response example (406)
"Not acceptable"
Response example (429)
"Too many requests"