Skip to content
EdgeKit

Resolve a schema

GET
/v1/iglu/api/schemas/{vendor}/{name}/{format}/{version}
curl --request GET \
  --url https://your-tenant-host/v1/iglu/api/schemas/com.acme/link_click/jsonschema/1-0-0 \
  --header 'Authorization: Bearer <token>'

The JSON Schema as the collector enforces it — read from the deployed document, so a schema that resolves here is one the collector already validates against. A schema published but not yet deployed answers 404, which is the same state the collector reports as a schema_not_found bad row.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
vendor
required
string
>= 1 characters

Example 

com.acme
name
required
string
>= 1 characters

Example 

link_click
format
required
string
>= 1 characters

Example 

jsonschema
version
required

SchemaVer — MODEL-REVISION-ADDITION, and not semver.

string
/^\d+-\d+-\d+$/

Example 

1-0-0

SchemaVer — MODEL-REVISION-ADDITION, and not semver.

Responses

Section titled “Responses”

200

Section titled “200”

The schema, verbatim, in its Iglu envelope.

Media typeapplication/json
object
key
additional properties

Example generated

{
  "additionalProperty": "example"
}

401

Section titled “401”

Missing or invalid credential.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

404

Section titled “404”

Resource not found.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Section titled “422”

Request validation failed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Section titled “500”

Unexpected error.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}