Skip to main content
GET
Get an app interface

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id
integer<int64>
required

the app id

interface_id
string
required

Identifier of the interface, as returned by the interface listing endpoints.

Response

OK

id
string
required

Identifier of the interface, unique within the app. The same identifiers are returned by GET /datasets/{dataset_id}/interfaces, so results from the two endpoints can be joined.

name
string
required

Human-readable name of the interface.

app_id
integer
required

ID of the installed app that owns this interface.

metadata
object
required

Interface metadata.

schema
object
required

JSON Schema for the interface's quick settings, used as the quick_settings object when configuring a connection to this interface. May embed a uischema key describing how the platform UI renders the settings form.

policy
object

The interface's collaboration policy, a JSON Schema metaschema that dataset schemas are validated against (as by GET /datasets/{dataset_id}/interfaces). Note this document can be large. Absent when the interface accepts any dataset schema.