{ "swagger": "2.0", "info": { "title": "golioth API", "version": "1.0" }, "host": "api.golioth.io", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v1/artifacts": { "post": { "operationId": "Artifacts_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "body", "description": " (streaming inputs)", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothCreateArtifactRequest" } } ], "tags": [ "Artifacts" ] } }, "/v1/billing/webhook": { "post": { "operationId": "Billing_PaymentWebhook", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothPaymentWebhookResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "raw", "in": "body", "required": true, "schema": { "type": "string", "format": "byte" } } ], "tags": [ "Billing" ] } }, "/v1/boards": { "get": { "operationId": "Boards_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListBoardsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "id", "in": "query", "required": false, "type": "string" }, { "name": "platform", "in": "query", "required": false, "type": "string" } ], "tags": [ "Boards" ] } }, "/v1/boards/{id}": { "get": { "operationId": "Boards_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetBoardsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "Boards" ] } }, "/v1/integration-types": { "get": { "operationId": "Integrations_ListIntegrationTypes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListIntegrationTypesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": [ "Integrations" ] } }, "/v1/organizations": { "get": { "operationId": "Organizations_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListOrganizationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "tags": [ "Organizations" ] }, "post": { "operationId": "Organizations_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateOrganizationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothCreateOrganizationRequest" } } ], "tags": [ "Organizations" ] } }, "/v1/organizations/{organizationId}": { "get": { "operationId": "Organizations_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetOrganizationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Organizations" ] }, "put": { "operationId": "Organizations_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateOrganizationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothOrganizationUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Organizations" ] }, "patch": { "operationId": "Organizations_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateOrganizationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothOrganizationUpdate" } } ], "tags": [ "Organizations" ] } }, "/v1/organizations/{organizationId}/checkout_sessions": { "post": { "operationId": "Billing_CreateCheckoutSession", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateCheckoutSessionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingCreateCheckoutSessionBody" } } ], "tags": [ "Billing" ] } }, "/v1/organizations/{organizationId}/customer_portal_sessions": { "post": { "operationId": "Billing_CreateCustomerPortalSession", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateCustomerPortalResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingCreateCustomerPortalSessionBody" } } ], "tags": [ "Billing" ] } }, "/v1/organizations/{organizationId}/quotas": { "get": { "operationId": "Organizations_GetQuota", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetOrganizationQuotaResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Organizations" ] } }, "/v1/organizations/{organizationId}/usage": { "get": { "operationId": "Usage_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListUsageResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string" }, { "name": "start", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "end", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "Usage" ] } }, "/v1/projects": { "get": { "operationId": "Projects_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListProjectResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "organizationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Projects" ] }, "post": { "operationId": "Projects_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateProjectResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothCreateProjectRequest" } } ], "tags": [ "Projects" ] } }, "/v1/projects/{projectId}": { "get": { "operationId": "Projects_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetProjectResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Projects" ] }, "delete": { "operationId": "Projects_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteProjectResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Projects" ] }, "put": { "operationId": "Projects_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateProjectResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothProjectUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Projects" ] }, "patch": { "operationId": "Projects_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateProjectResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothProjectUpdate" } } ], "tags": [ "Projects" ] } }, "/v1/projects/{projectId}/apikeys": { "get": { "operationId": "APIKeys_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListAPIKeyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": [ "API Keys" ] }, "post": { "operationId": "APIKeys_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateAPIKeyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothAPIKeysCreateBody" } } ], "tags": [ "API Keys" ] } }, "/v1/projects/{projectId}/apikeys/{apikeyId}": { "delete": { "operationId": "APIKeys_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteAPIKeyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "apikeyId", "in": "path", "required": true, "type": "string" } ], "tags": [ "API Keys" ] }, "patch": { "operationId": "APIKeys_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateAPIKeyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "apikeyId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothAPIKeyUpdate" } } ], "tags": [ "API Keys" ] } }, "/v1/projects/{projectId}/artifacts": { "get": { "operationId": "Artifacts_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "version", "in": "query", "required": false, "type": "string" }, { "name": "blueprintId", "in": "query", "required": false, "type": "string" }, { "name": "package", "in": "query", "required": false, "type": "string" }, { "name": "ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "Artifacts" ] } }, "/v1/projects/{projectId}/artifacts/{artifactId}": { "get": { "operationId": "Artifacts_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "artifactId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Artifacts" ] }, "delete": { "operationId": "Artifacts_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "artifactId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Artifacts" ] }, "put": { "operationId": "Artifacts_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "artifactId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothArtifactUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Artifacts" ] }, "patch": { "operationId": "Artifacts_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "artifactId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothArtifactUpdate" } } ], "tags": [ "Artifacts" ] } }, "/v1/projects/{projectId}/blueprints": { "get": { "operationId": "Blueprints_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListBlueprintResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "blueprintName", "in": "query", "required": false, "type": "string" }, { "name": "ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "boardId", "in": "query", "required": false, "type": "string" }, { "name": "platform", "in": "query", "required": false, "type": "string" } ], "tags": [ "Blueprints" ] }, "post": { "operationId": "Blueprints_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateBlueprintResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothBlueprintsCreateBody" } } ], "tags": [ "Blueprints" ] } }, "/v1/projects/{projectId}/blueprints/{blueprintId}": { "get": { "operationId": "Blueprints_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetBlueprintResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "blueprintId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Blueprints" ] }, "delete": { "operationId": "Blueprints_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteBlueprintResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "blueprintId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Blueprints" ] }, "put": { "operationId": "Blueprints_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateBlueprintResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "blueprintId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothBlueprintUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Blueprints" ] }, "patch": { "operationId": "Blueprints_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateBlueprintResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "blueprintId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothBlueprintUpdate" } } ], "tags": [ "Blueprints" ] } }, "/v1/projects/{projectId}/certificates": { "get": { "operationId": "Certificates_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListCertificateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "description": "TODO: filter by: device_id, enabled/disabled, start/end expiration date, cert type, may increase filters in the future", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": [ "Certificates" ] }, "post": { "operationId": "Certificates_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateCertificateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothCertificatesCreateBody" } } ], "tags": [ "Certificates" ] } }, "/v1/projects/{projectId}/certificates/{certificateId}": { "get": { "operationId": "Certificates_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetCertificateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "certificateId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Certificates" ] }, "delete": { "operationId": "Certificates_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteCertificateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "certificateId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Certificates" ] } }, "/v1/projects/{projectId}/credentials": { "post": { "operationId": "Credentials_Create2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateCredentialResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothCredentialsCreateBody" } } ], "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/credentials/{credentialId}": { "delete": { "operationId": "Credentials_Delete2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteCredentialResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "credentialId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/device-activity-logs": { "get": { "operationId": "Logs_GetLatestDeviceActivityLogs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetLatestDeviceActivityLogsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": [ "Logs" ] } }, "/v1/projects/{projectId}/devices": { "get": { "operationId": "Devices_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "deviceName", "in": "query", "required": false, "type": "string" }, { "name": "hardwareId", "in": "query", "required": false, "type": "string" }, { "name": "tags", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "blueprintId", "in": "query", "required": false, "type": "string" }, { "name": "statePath", "in": "query", "required": false, "type": "string" }, { "name": "streamPath", "in": "query", "required": false, "type": "string" }, { "name": "updatePath", "in": "query", "required": false, "type": "string" }, { "name": "term", "in": "query", "required": false, "type": "string" }, { "name": "enabled", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "Devices" ] }, "post": { "operationId": "Devices_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothDevicesCreateBody" } } ], "tags": [ "Devices" ] } }, "/v1/projects/{projectId}/devices/{deviceId}": { "get": { "operationId": "Devices_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Devices" ] }, "delete": { "operationId": "Devices_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Devices" ] }, "put": { "operationId": "Devices_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothDeviceUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Devices" ] }, "patch": { "operationId": "Devices_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothDeviceUpdate" } } ], "tags": [ "Devices" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/credentials": { "get": { "operationId": "Credentials_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListCredentialResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Credentials" ] }, "post": { "operationId": "Credentials_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateCredentialResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothCredentialsCreateBody" } } ], "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/credentials/{credentialId}": { "delete": { "operationId": "Credentials_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteCredentialResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "credentialId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/data/{path}": { "get": { "operationId": "DeviceState_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" } ], "tags": [ "LightDB" ] }, "delete": { "operationId": "DeviceState_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" } ], "tags": [ "LightDB" ] }, "post": { "operationId": "DeviceState_Update3", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" }, { "name": "value", "in": "body", "required": true, "schema": {} } ], "tags": [ "LightDB" ] }, "put": { "operationId": "DeviceState_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" }, { "name": "value", "in": "body", "required": true, "schema": {} } ], "tags": [ "LightDB" ] }, "patch": { "operationId": "DeviceState_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" }, { "name": "value", "in": "body", "required": true, "schema": {} } ], "tags": [ "LightDB" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/provisioning": { "post": { "operationId": "Provisioning_ProvisionDevice2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothProvisionDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProvisioningProvisionDeviceBody" } } ], "tags": [ "Provisioning" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/rpc": { "post": { "operationId": "DeviceRemoteProcedureCall_RemoteProcedureCall", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothRemoteProcedureCallResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceRemoteProcedureCallRemoteProcedureCallBody" } } ], "tags": [ "Remote Procedure Call" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/settings": { "get": { "operationId": "Settings_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetSettingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Settings" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/stream": { "get": { "operationId": "DeviceStream_GetDeviceStream", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetDeviceStreamResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "start", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "end", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "required": false, "type": "string" }, { "name": "encodedQuery", "in": "query", "required": false, "type": "string" }, { "name": "query.timeBucket", "in": "query", "required": false, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "tags": [ "LightDB Stream" ] }, "post": { "operationId": "DeviceStream_GetDeviceStream2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetDeviceStreamResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceStreamGetDeviceStreamBody" } } ], "tags": [ "LightDB Stream" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/stream/latest/{path}": { "get": { "operationId": "DeviceStream_GetLatestStream", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" } ], "tags": [ "LightDB Stream" ] } }, "/v1/projects/{projectId}/devicesByTag/{tag}/data/{path}": { "delete": { "operationId": "DeviceState_DeleteByTag", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tag", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" } ], "tags": [ "LightDB" ] }, "post": { "operationId": "DeviceState_UpdateByTag3", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tag", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" }, { "name": "value", "in": "body", "required": true, "schema": {} } ], "tags": [ "LightDB" ] }, "put": { "operationId": "DeviceState_UpdateByTag", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tag", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" }, { "name": "value", "in": "body", "required": true, "schema": {} } ], "tags": [ "LightDB" ] }, "patch": { "operationId": "DeviceState_UpdateByTag2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateDeviceStateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tag", "in": "path", "required": true, "type": "string" }, { "name": "path", "in": "path", "required": true, "type": "string", "pattern": ".+" }, { "name": "value", "in": "body", "required": true, "schema": {} } ], "tags": [ "LightDB" ] } }, "/v1/projects/{projectId}/firmware/logs": { "get": { "operationId": "Firmwares_Logs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListFirmwareLogsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "version", "in": "query", "required": false, "type": "string" }, { "name": "target", "in": "query", "required": false, "type": "string" }, { "name": "state", "in": "query", "required": false, "type": "string" }, { "name": "reason", "in": "query", "required": false, "type": "string" }, { "name": "deviceId", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "start", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "end", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "Firmware" ] } }, "/v1/projects/{projectId}/integrations": { "get": { "operationId": "Integrations_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "type", "in": "query", "required": false, "type": "string" } ], "tags": [ "Integrations" ] }, "post": { "operationId": "Integrations_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothIntegrationsCreateBody" } } ], "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/integrations/validate": { "post": { "operationId": "Integrations_Validate", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothIntegrationValidationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationsValidateBody" } } ], "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/integrations/{integrationId}": { "get": { "operationId": "Integrations_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "integrationId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Integrations" ] }, "delete": { "operationId": "Integrations_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "integrationId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Integrations" ] }, "put": { "operationId": "Integrations_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "integrationId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothIntegrationUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Integrations" ] }, "patch": { "operationId": "Integrations_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "integrationId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothIntegrationUpdate" } } ], "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/integrations/{integrationId}/test": { "post": { "operationId": "Integrations_Test", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothTestIntegrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "integrationId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationsTestBody" } } ], "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/logs": { "get": { "operationId": "Logs_GetLogs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetLogsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "deviceId", "in": "query", "required": false, "type": "string" }, { "name": "start", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "end", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "module", "in": "query", "required": false, "type": "string" }, { "name": "level", "in": "query", "required": false, "type": "string", "enum": [ "NONE", "DEBUG", "INFO", "WARN", "ERROR" ], "default": "NONE" }, { "name": "term", "in": "query", "required": false, "type": "string" }, { "name": "tags", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "Logs" ] } }, "/v1/projects/{projectId}/permissions": { "get": { "operationId": "Access_ListPermissions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListPermissionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Access" ] } }, "/v1/projects/{projectId}/policies": { "get": { "operationId": "Access_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListPolicyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "userId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Access" ] } }, "/v1/projects/{projectId}/policies/{policyId}": { "get": { "operationId": "Access_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetPolicyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "policyId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Access" ] }, "delete": { "operationId": "Access_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeletePolicyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "policyId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Access" ] }, "put": { "operationId": "Access_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdatePolicyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "policyId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothPolicyUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Access" ] }, "patch": { "operationId": "Access_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdatePolicyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "policyId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothPolicyUpdate" } } ], "tags": [ "Access" ] } }, "/v1/projects/{projectId}/provisioning": { "post": { "operationId": "Provisioning_ProvisionDevice", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothProvisionDeviceResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProvisioningProvisionDeviceBody" } } ], "tags": [ "Provisioning" ] } }, "/v1/projects/{projectId}/releases": { "get": { "operationId": "Releases_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListReleaseResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "releaseTags", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "deviceTags", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "rollout", "in": "query", "required": false, "type": "boolean" }, { "name": "blueprintId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Releases" ] }, "post": { "operationId": "Releases_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateReleaseResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothReleasesCreateBody" } } ], "tags": [ "Releases" ] } }, "/v1/projects/{projectId}/releases/{releaseId}": { "get": { "operationId": "Releases_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetReleaseResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "releaseId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Releases" ] }, "delete": { "operationId": "Releases_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteReleaseResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "releaseId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Releases" ] }, "put": { "operationId": "Releases_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateReleaseResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "releaseId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothReleaseUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Releases" ] }, "patch": { "operationId": "Releases_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateReleaseResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "releaseId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothReleaseUpdate" } } ], "tags": [ "Releases" ] } }, "/v1/projects/{projectId}/settings": { "get": { "operationId": "Settings_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListSettingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "blueprintId", "in": "query", "required": false, "type": "string" }, { "name": "deviceId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Settings" ] }, "post": { "operationId": "Settings_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateSettingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothSettingsCreateBody" } } ], "tags": [ "Settings" ] } }, "/v1/projects/{projectId}/settings/{settingId}": { "delete": { "operationId": "Settings_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteSettingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "settingId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Settings" ] }, "put": { "operationId": "Settings_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateSettingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "settingId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothSettingUpdate" } } ], "tags": [ "Settings" ] }, "patch": { "operationId": "Settings_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateSettingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "settingId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothSettingUpdate" } } ], "tags": [ "Settings" ] } }, "/v1/projects/{projectId}/stream": { "get": { "operationId": "DeviceStream_GetProjectStream", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetProjectStreamResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "start", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "end", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "required": false, "type": "string" }, { "name": "encodedQuery", "in": "query", "required": false, "type": "string" }, { "name": "query.timeBucket", "in": "query", "required": false, "type": "string" }, { "name": "deviceId", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "tags", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "LightDB Stream" ] }, "post": { "operationId": "DeviceStream_GetProjectStream2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetProjectStreamResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceStreamGetProjectStreamBody" } } ], "tags": [ "LightDB Stream" ] } }, "/v1/projects/{projectId}/tags": { "get": { "operationId": "Tags_List", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListTagResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "perPage", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "tagName", "in": "query", "required": false, "type": "string" }, { "name": "ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "Tags" ] }, "post": { "operationId": "Tags_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothCreateTagResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothTagsCreateBody" } } ], "tags": [ "Tags" ] } }, "/v1/projects/{projectId}/tags/{tagId}": { "get": { "operationId": "Tags_Get", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothGetTagResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tagId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Tags" ] }, "delete": { "operationId": "Tags_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothDeleteTagResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tagId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Tags" ] }, "put": { "operationId": "Tags_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateTagResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tagId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothTagUpdate" } }, { "name": "updateMask", "in": "query", "required": false, "type": "string" } ], "tags": [ "Tags" ] }, "patch": { "operationId": "Tags_Update2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothUpdateTagResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "tagId", "in": "path", "required": true, "type": "string" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/goliothTagUpdate" } } ], "tags": [ "Tags" ] } }, "/v1/projects/{projectId}/users": { "get": { "operationId": "Access_ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListUsersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Access" ] } }, "/v1/projects/{projectId}/users/invitation": { "post": { "operationId": "Access_InviteUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothInviteUserResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccessInviteUserBody" } } ], "tags": [ "Access" ] } }, "/v1/roles": { "get": { "operationId": "Access_ListRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListRoleResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "tags": [ "Access" ] } }, "/v1/settings-data-types": { "get": { "operationId": "Settings_ListAllowedSettingsDataTypes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/goliothListAllowedSettingsDataTypesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "tags": [ "Settings" ] } } }, "definitions": { "AccessInviteUserBody": { "type": "object", "properties": { "email": { "type": "string" } } }, "BillingCreateCheckoutSessionBody": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothSubscriptionItem" } }, "callbackPath": { "type": "string" } } }, "BillingCreateCustomerPortalSessionBody": { "type": "object", "properties": { "callbackPath": { "type": "string" } } }, "DeviceRemoteProcedureCallRemoteProcedureCallBody": { "type": "object", "properties": { "method": { "type": "string" }, "params": { "type": "array", "items": {} }, "timeout": { "type": "integer", "format": "int64" } } }, "DeviceStreamGetDeviceStreamBody": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "interval": { "type": "string" }, "encodedQuery": { "type": "string" }, "query": { "$ref": "#/definitions/goliothDeviceStreamQuery" }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" } } }, "DeviceStreamGetProjectStreamBody": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "interval": { "type": "string" }, "encodedQuery": { "type": "string" }, "query": { "$ref": "#/definitions/goliothDeviceStreamQuery" }, "deviceId": { "type": "array", "items": { "type": "string" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "IntegrationsTestBody": { "type": "object", "properties": { "data": { "type": "object" } } }, "IntegrationsValidateBody": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" } } }, "ProvisioningProvisionDeviceBody": { "type": "object", "properties": { "hardwareIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "type": { "$ref": "#/definitions/goliothCredentialType" }, "identity": { "type": "string" }, "preSharedKey": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "blueprintId": { "type": "string", "title": "string publicKey\nstring encryption" } } }, "comgoliothTag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "goliothAPIKey": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/definitions/goliothAPIKeyType" }, "secret": { "type": "string" }, "policyId": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "keyTags": { "type": "array", "items": { "type": "string" } } } }, "goliothAPIKeyType": { "type": "string", "enum": [ "API_KEY", "JWT_KEY" ], "default": "API_KEY" }, "goliothAPIKeyUpdate": { "type": "object", "properties": { "type": { "$ref": "#/definitions/goliothAPIKeyType" }, "keyTags": { "type": "array", "items": { "type": "string" } } } }, "goliothAPIKeysCreateBody": { "type": "object", "properties": { "type": { "$ref": "#/definitions/goliothAPIKeyType" }, "keyTags": { "type": "array", "items": { "type": "string" } } } }, "goliothArtifact": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "package": { "type": "string" }, "blueprintId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "binaryInfo": { "type": "object" }, "size": { "type": "string", "format": "uint64" } } }, "goliothArtifactUpdate": { "type": "object" }, "goliothBlueprint": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "boardId": { "type": "string" }, "platform": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "goliothBlueprintUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "boardId": { "type": "string" }, "platform": { "type": "string" } } }, "goliothBlueprintsCreateBody": { "type": "object", "properties": { "name": { "type": "string" }, "boardId": { "type": "string" }, "platform": { "type": "string" } } }, "goliothBoard": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "arch": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "string" } } } }, "goliothCertificate": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "enabled": { "type": "boolean" }, "certType": { "type": "string" }, "certificateContent": { "$ref": "#/definitions/goliothCertificateContent" }, "createdAt": { "type": "string", "format": "date-time" } } }, "goliothCertificateContent": { "type": "object", "properties": { "signature": { "type": "string", "format": "byte" }, "signatureAlgorithm": { "type": "string" }, "publicKeyAlgorithm": { "type": "string" }, "publicKey": { "type": "string", "format": "byte" }, "version": { "type": "integer", "format": "int64" }, "serialNumber": { "type": "string" }, "issuer": { "type": "string" }, "subject": { "type": "string" }, "notBefore": { "type": "string", "format": "date-time" }, "notAfter": { "type": "string", "format": "date-time" }, "keyUsages": { "type": "array", "items": { "type": "string" } } } }, "goliothCertificatesCreateBody": { "type": "object", "properties": { "certFile": { "type": "string", "format": "byte" }, "certType": { "type": "string" } } }, "goliothConditionalMap": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, "goliothCreateAPIKeyResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothAPIKey" } } }, "goliothCreateArtifactRequest": { "type": "object", "properties": { "projectId": { "type": "string" }, "content": { "type": "string", "format": "byte" }, "version": { "type": "string" }, "blueprintId": { "type": "string" }, "package": { "type": "string" } } }, "goliothCreateArtifactResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothArtifact" } } }, "goliothCreateBlueprintResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothBlueprint" } } }, "goliothCreateCertificateResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothCertificate" } } }, "goliothCreateCheckoutSessionResponse": { "type": "object", "properties": { "url": { "type": "string" } } }, "goliothCreateCredentialResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothCredential" } } }, "goliothCreateCustomerPortalResponse": { "type": "object", "properties": { "url": { "type": "string" } } }, "goliothCreateDeviceResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothDevice" } } }, "goliothCreateIntegrationResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothIntegration" } } }, "goliothCreateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "website": { "type": "string" } } }, "goliothCreateOrganizationResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothOrganization" } } }, "goliothCreateProjectRequest": { "type": "object", "properties": { "name": { "type": "string" }, "organizationId": { "type": "string" } } }, "goliothCreateProjectResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothProject" } } }, "goliothCreateReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothRelease" } } }, "goliothCreateSettingResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothSetting" } } }, "goliothCreateTagResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/comgoliothTag" } } }, "goliothCredential": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/goliothCredentialType" }, "identity": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "preSharedKey": { "type": "string" } } }, "goliothCredentialType": { "type": "string", "enum": [ "PRE_SHARED_KEY", "ASYMMETRIC_KEY_PAIR" ], "default": "PRE_SHARED_KEY" }, "goliothCredentialsCreateBody": { "type": "object", "properties": { "deviceId": { "type": "string" }, "type": { "$ref": "#/definitions/goliothCredentialType" }, "identity": { "type": "string" }, "preSharedKey": { "type": "string" } } }, "goliothDeleteAPIKeyResponse": { "type": "object" }, "goliothDeleteArtifactResponse": { "type": "object" }, "goliothDeleteBlueprintResponse": { "type": "object" }, "goliothDeleteCertificateResponse": { "type": "object" }, "goliothDeleteCredentialResponse": { "type": "object" }, "goliothDeleteDeviceResponse": { "type": "object" }, "goliothDeleteDeviceStateResponse": { "type": "object" }, "goliothDeleteIntegrationResponse": { "type": "object" }, "goliothDeletePolicyResponse": { "type": "object" }, "goliothDeleteProjectResponse": { "type": "object" }, "goliothDeleteReleaseResponse": { "type": "object" }, "goliothDeleteSettingResponse": { "type": "object" }, "goliothDeleteTagResponse": { "type": "object" }, "goliothDevice": { "type": "object", "properties": { "id": { "type": "string" }, "hardwareIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "blueprintId": { "type": "string" }, "data": { "type": "object" }, "lastReport": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "metadata": { "$ref": "#/definitions/goliothDeviceMetadata" }, "enabled": { "type": "boolean" }, "certificateId": { "type": "string" } } }, "goliothDeviceActivityLog": { "type": "object", "properties": { "deviceId": { "type": "string" }, "lastReport": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "deviceName": { "type": "string" }, "status": { "type": "string" }, "lastSeenOnline": { "type": "string", "format": "date-time" }, "lastSeenOffline": { "type": "string", "format": "date-time" } } }, "goliothDeviceLogEntry": { "type": "object", "example": { "device_id": "612d3cecf3ee17d321adbec6", "level": 2, "message": "Hello", "metadata": {}, "module": "default", "project_id": "esp32-test", "timestamp": { "nanos": 250818000, "seconds": 1642796612 } }, "properties": { "timestamp": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/definitions/goliothDeviceLogType" }, "level": { "$ref": "#/definitions/goliothDeviceLogLevel" }, "module": { "type": "string" }, "moduleId": { "type": "string" }, "message": { "type": "string" }, "metadata": { "type": "object" }, "deviceId": { "type": "string" } }, "description": "Event generated when a device sends logs." }, "goliothDeviceLogLevel": { "type": "string", "enum": [ "NONE", "DEBUG", "INFO", "WARN", "ERROR" ], "default": "NONE" }, "goliothDeviceLogType": { "type": "string", "enum": [ "LOGGING", "DIAGNOSTICS", "METRICS" ], "default": "LOGGING" }, "goliothDeviceMetadata": { "type": "object", "properties": { "update": { "type": "object" }, "status": { "type": "string" }, "lastReport": { "type": "string", "format": "date-time" }, "lastSeenOnline": { "type": "string", "format": "date-time" }, "lastSeenOffline": { "type": "string", "format": "date-time" }, "lastSettingsStatus": { "$ref": "#/definitions/goliothSettingsStatus" } } }, "goliothDeviceStreamQuery": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothQueryField" } }, "filters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothQueryFilter" } }, "timeBucket": { "type": "string" } } }, "goliothDeviceUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "addHardwareId": { "type": "array", "items": { "type": "string" } }, "removeHardwareId": { "type": "array", "items": { "type": "string" } }, "hardwareIds": { "type": "array", "items": { "type": "string" } }, "addTagId": { "type": "array", "items": { "type": "string" } }, "removeTagId": { "type": "array", "items": { "type": "string" } }, "blueprintId": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } } }, "goliothDevicesCreateBody": { "type": "object", "properties": { "name": { "type": "string" }, "hardwareIds": { "type": "array", "items": { "type": "string" } }, "tagIds": { "type": "array", "items": { "type": "string" } }, "blueprintId": { "type": "string" } } }, "goliothFirmwareLogEntry": { "type": "object", "properties": { "time": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "target": { "type": "string" }, "stateCode": { "type": "string" }, "state": { "type": "string" }, "reasonCode": { "type": "string" }, "reason": { "type": "string" }, "deviceId": { "type": "string" }, "package": { "type": "string" } } }, "goliothGetArtifactResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothArtifact" } } }, "goliothGetBlueprintResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothBlueprint" } } }, "goliothGetBoardsResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothBoard" } } }, "goliothGetCertificateResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothCertificate" } } }, "goliothGetDeviceResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothDevice" } } }, "goliothGetDeviceStateResponse": { "type": "object", "properties": { "data": {} } }, "goliothGetDeviceStreamResponse": { "type": "object", "properties": { "list": { "type": "array", "items": {} }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothGetIntegrationResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothIntegration" } } }, "goliothGetLatestDeviceActivityLogsResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothDeviceActivityLog" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothGetLogsResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothDeviceLogEntry" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothGetOrganizationQuotaResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothOrganizationQuota" } } }, "goliothGetOrganizationResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothOrganization" } } }, "goliothGetPolicyResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothPolicy" } } }, "goliothGetProjectResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothProject" } } }, "goliothGetProjectStreamResponse": { "type": "object", "properties": { "list": { "type": "array", "items": {} }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothGetReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothRelease" } } }, "goliothGetSettingResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothSetting" } }, "total": { "type": "integer", "format": "int64" } } }, "goliothGetTagResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/comgoliothTag" } } }, "goliothIntegration": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" } } }, "goliothIntegrationType": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothIntegrationTypeAttribute" } } } }, "goliothIntegrationTypeAttribute": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "displayName": { "type": "string" } } }, "goliothIntegrationUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "enabled": { "type": "boolean" }, "configuration": { "type": "object" } } }, "goliothIntegrationValidationResponse": { "type": "object" }, "goliothIntegrationsCreateBody": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" } } }, "goliothInviteUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothPolicy" } } }, "goliothListAPIKeyResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothAPIKey" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListAllowedSettingsDataTypesResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothSettingDataType" } }, "total": { "type": "integer", "format": "int64" } } }, "goliothListArtifactResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothArtifact" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListBlueprintResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothBlueprint" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListBoardsResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothBoard" } }, "total": { "type": "integer", "format": "int64" } } }, "goliothListCertificateResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothCertificate" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListCredentialResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothCredential" } } } }, "goliothListDeviceResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothDevice" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListFirmwareLogsResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothFirmwareLogEntry" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListIntegrationResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothIntegration" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListIntegrationTypesResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothIntegrationType" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListOrganizationResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothOrganization" } } } }, "goliothListPermissionResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothPermission" } } } }, "goliothListPolicyResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothPolicy" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListProjectResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothProject" } } } }, "goliothListReleaseResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothRelease" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListRoleResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothRole" } } } }, "goliothListSettingResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothSetting" } }, "total": { "type": "integer", "format": "int64" } } }, "goliothListTagResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/comgoliothTag" } }, "page": { "type": "integer", "format": "int64" }, "perPage": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "goliothListUsageResponse": { "type": "object", "properties": { "unit": { "$ref": "#/definitions/goliothUsageUnit" }, "dates": { "type": "object", "additionalProperties": { "$ref": "#/definitions/goliothUsageSummaries" } } } }, "goliothListUsersResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothUser" } } } }, "goliothOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "roles": { "type": "array", "items": { "type": "string" } }, "tier": { "type": "string" }, "paymentStatus": { "type": "string" }, "website": { "type": "string" } } }, "goliothOrganizationQuota": { "type": "object", "properties": { "quotas": { "type": "object", "additionalProperties": { "$ref": "#/definitions/goliothQuota" } } } }, "goliothOrganizationUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "website": { "type": "string" } } }, "goliothPaymentWebhookResponse": { "type": "object" }, "goliothPermission": { "type": "object", "properties": { "resource": { "type": "string" }, "action": { "type": "string" } } }, "goliothPolicy": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "conditionals": { "$ref": "#/definitions/goliothConditionalMap" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "goliothPolicyUpdate": { "type": "object", "properties": { "addRoles": { "type": "array", "items": { "type": "string" } }, "removeRoles": { "type": "array", "items": { "type": "string" } }, "addTags": { "type": "array", "items": { "type": "string" } }, "removeTags": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "tagIds": { "type": "array", "items": { "type": "string" } } } }, "goliothProject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "roles": { "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string" } } }, "goliothProjectUpdate": { "type": "object", "properties": { "name": { "type": "string" } } }, "goliothProvisionData": { "type": "object", "properties": { "deviceId": { "type": "string" } } }, "goliothProvisionDeviceResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothProvisionData" } } }, "goliothQueryField": { "type": "object", "properties": { "path": { "type": "string" }, "type": { "type": "string" }, "alias": { "type": "string" }, "agg": { "type": "string" } } }, "goliothQueryFilter": { "type": "object", "properties": { "path": { "type": "string" }, "op": { "type": "string" }, "value": {}, "filters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothQueryFilter" } } } }, "goliothQuota": { "type": "object", "properties": { "current": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" } } }, "goliothRelease": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "releaseTags": { "type": "array", "items": { "type": "string" } }, "deviceTagIds": { "type": "array", "items": { "type": "string" } }, "suitManifest": { "type": "object" }, "artifactIds": { "type": "array", "items": { "type": "string" } }, "rollout": { "type": "boolean" }, "sequenceNumber": { "type": "string", "format": "int64" }, "blueprintId": { "type": "string" } } }, "goliothReleaseUpdate": { "type": "object", "properties": { "addDeviceTagId": { "type": "array", "items": { "type": "string" } }, "removeDeviceTagId": { "type": "array", "items": { "type": "string" } }, "deviceTagIds": { "type": "array", "items": { "type": "string" } }, "rollout": { "type": "boolean" }, "addReleaseTag": { "type": "array", "items": { "type": "string" } }, "removeReleaseTag": { "type": "array", "items": { "type": "string" } }, "releaseTags": { "type": "array", "items": { "type": "string" } } } }, "goliothReleasesCreateBody": { "type": "object", "properties": { "releaseTags": { "type": "array", "items": { "type": "string" } }, "deviceTagIds": { "type": "array", "items": { "type": "string" } }, "artifactIds": { "type": "array", "items": { "type": "string" } }, "rollout": { "type": "boolean" } } }, "goliothRemoteProcedureCallResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int64" }, "detail": {} } }, "goliothRole": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "children": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothPermission" } } } }, "goliothSetting": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {}, "dataType": { "type": "string" }, "projectId": { "type": "string" }, "blueprintId": { "type": "string" }, "deviceId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "goliothSettingDataType": { "type": "object", "properties": { "type": { "type": "string" } } }, "goliothSettingError": { "type": "object", "properties": { "key": { "type": "string" }, "code": { "type": "integer", "format": "int64" }, "codeDescription": { "type": "string" }, "deviceDetails": { "type": "string" } } }, "goliothSettingUpdate": { "type": "object", "properties": { "value": {} } }, "goliothSettingsCreateBody": { "type": "object", "properties": { "key": { "type": "string" }, "dataType": { "type": "string" }, "value": {}, "blueprintId": { "type": "string" }, "deviceId": { "type": "string" } } }, "goliothSettingsStatus": { "type": "object", "properties": { "syncTime": { "type": "string", "format": "date-time" }, "reportedVersion": { "type": "string" }, "status": { "type": "string" }, "statusDetail": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothSettingError" } } } }, "goliothSubscriptionItem": { "type": "object", "properties": { "lookupKey": { "type": "string" }, "quantity": { "type": "string", "format": "int64" } } }, "goliothTagUpdate": { "type": "object", "properties": { "name": { "type": "string" } } }, "goliothTagsCreateBody": { "type": "object", "properties": { "name": { "type": "string" } } }, "goliothTestIntegrationResponse": { "type": "object", "properties": { "result": { "type": "string" } } }, "goliothUpdateAPIKeyResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothAPIKey" } } }, "goliothUpdateArtifactResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothArtifact" } } }, "goliothUpdateBlueprintResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothBlueprint" } } }, "goliothUpdateDeviceResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothDevice" } } }, "goliothUpdateDeviceStateResponse": { "type": "object", "properties": { "data": {} } }, "goliothUpdateIntegrationResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothIntegration" } } }, "goliothUpdateOrganizationResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothOrganization" } } }, "goliothUpdatePolicyResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothPolicy" } } }, "goliothUpdateProjectResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothProject" } } }, "goliothUpdateReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothRelease" } } }, "goliothUpdateSettingResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/goliothSetting" } } }, "goliothUpdateTagResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/comgoliothTag" } } }, "goliothUsageSummaries": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/goliothUsageSummary" } } } }, "goliothUsageSummary": { "type": "object", "properties": { "projectId": { "type": "string" }, "service": { "type": "string" }, "quantity": { "type": "string", "format": "uint64" } } }, "goliothUsageUnit": { "type": "string", "enum": [ "KILOBYTES" ], "default": "KILOBYTES" }, "goliothUser": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "profileUrl": { "type": "string" }, "emailVerified": { "type": "boolean" }, "policyId": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {} }, "protobufNullValue": { "type": "string", "enum": [ "NULL_VALUE" ], "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protobufAny" } } } } }, "securityDefinitions": { "API Key": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "security": [ { "API Key": [], "Bearer": [] } ], "externalDocs": { "description": "golioth API", "url": "https://docs.golioth.io" } }