Skip to content

List supported resource types

GET
/api/v1/resource-types
curl --request GET \
--url https://api.aletheia-ops.com/api/v1/resource-types \
--header 'Authorization: Bearer <token>'

OK

Media typeapplication/json

GET /resource-types response

object
items
Array<object>

One coverage-registry entry (plan 05 §2.2)

object
resource_type
string
service
string
display_name
string
global
boolean
supported_since
string
Examplegenerated
{
"items": [
{
"resource_type": "example",
"service": "example",
"display_name": "example",
"global": true,
"supported_since": "example"
}
]
}

No valid credential was presented, or it has expired.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "unauthorized",
"message": "authentication required"
}

Authenticated, but not permitted to perform this action.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "forbidden",
"message": "you do not have permission to perform this action"
}

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Exampleinternal_error
{
"code": "internal_error",
"message": "internal server error"
}