Skip to content
Speccy

List the profiles, with their current versions.

GET
/profiles
curl --request GET \
  --url https://example.com/api/v1/profiles

Responses

Section titled “ Responses ”

200

Section titled “200”

The profiles.

Media typeapplication/json
object
items
required
Array<object>
object
key
required
string
name
required
string
version
required
integer format: int64
origin
required

Built-in, or the path of the profile file.

string
problems
required

Profile files that did not load, with the reason.

Array<string>
Examplegenerated
{
  "items": [
    {
      "key": "example",
      "name": "example",
      "version": 1,
      "origin": "example"
    }
  ],
  "problems": [
    "example"
  ]
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}