List TSDBv2 schemas

GET/projects/{projectId}/tsdb/v2/schemas

Base URL: https://api.tinkermode.com

Get the list of all TSDBv2 schemas of a project.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a project API key.

Path parameters

NameTypeRequiredConstraintsDescription
projectIdintegerYesThe unique ID for a specified project.

Responses

200 Successfully retrieved list of schemas.

Content type: application/json

Response body from creating or retrieving a schema.

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
metricsarray<object>No
Properties of metrics
PropertyTypeRequiredConstraintsDescription
namestringYesread-only (server-generated)Name of the metric.
tagsarray<object>No
Properties of tags
PropertyTypeRequiredConstraintsDescription
keystringYesName of the metric tag.
valuestringNoValue of the metric tag.
namestringNoread-only (server-generated)Name of the schema.
totalMetricsintegerNoread-only (server-generated)Total number of metrics in schema.

401 Authorization is required to access this resource.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.