components: schemas: AccessInviteUserBody: properties: email: type: string type: object BillingCreateCustomerPortalSessionBody: properties: callbackPath: type: string type: object DeviceRemoteProcedureCallRemoteProcedureCallBody: properties: method: type: string params: items: {} type: array timeout: format: int64 type: integer type: object DeviceStreamGetDeviceStreamBody: properties: encodedQuery: type: string end: format: date-time type: string interval: type: string page: format: int64 type: integer perPage: format: int64 type: integer query: $ref: '#/components/schemas/goliothDeviceStreamQuery' start: format: date-time type: string type: object DeviceStreamGetProjectStreamBody: properties: deviceId: items: type: string type: array encodedQuery: type: string end: format: date-time type: string interval: type: string page: format: int64 type: integer perPage: format: int64 type: integer query: $ref: '#/components/schemas/goliothDeviceStreamQuery' start: format: date-time type: string tags: items: type: string type: array type: object IntegrationsTestBody: properties: data: type: object type: object IntegrationsValidateBody: properties: configuration: type: object enabled: type: boolean name: type: string type: type: string type: object ListUsageResponseUsageEntity: default: PROJECT enum: - PROJECT - DEVICE - PIPELINE type: string NotificationLevel: default: INFO enum: - INFO - WARNING - ERROR type: string PKICreatePKIPolicyBody: properties: policyId: type: string providerId: type: string type: type: string type: object PKIUpdatePKIPolicyBody: properties: providerId: type: string type: type: string type: object ProjectConfigSetBody: properties: value: $ref: '#/components/schemas/goliothProjectConfigValue' type: object ProvisioningProvisionDeviceBody: properties: blueprintId: type: string cohortId: title: 'string publicKey string encryption' type: string hardwareIds: items: type: string type: array identity: type: string name: type: string preSharedKey: type: string tagIds: items: type: string type: array type: $ref: '#/components/schemas/goliothCredentialType' type: object comgoliothTag: properties: createdAt: format: date-time type: string id: type: string name: type: string updatedAt: format: date-time type: string type: object goliothAPIKey: properties: createdAt: format: date-time type: string id: type: string key: type: string keyTags: items: type: string type: array name: type: string policyId: type: string roles: items: type: string type: array secret: type: string type: $ref: '#/components/schemas/goliothAPIKeyType' type: object goliothAPIKeyType: default: API_KEY enum: - API_KEY - JWT_KEY - API_KEY_V2 type: string goliothAPIKeyUpdate: properties: keyTags: items: type: string type: array name: type: string type: $ref: '#/components/schemas/goliothAPIKeyType' type: object goliothAPIKeysCreateBody: properties: keyTags: items: type: string type: array name: type: string type: $ref: '#/components/schemas/goliothAPIKeyType' type: object goliothAWSAuthOptionsAccessKey: properties: accessKeyId: type: string secretAccessKey: type: string title: Access key based authentication type: object goliothAWSAuthOptionsWebIdentity: properties: roleArn: description: ARN for the AWS IAM Role the Golioth PKI Service should assume. type: string title: WebIdentity based authentication type: object goliothAWSProviderOptions: properties: accessKey: $ref: '#/components/schemas/goliothAWSAuthOptionsAccessKey' region: title: AWS region, e.g. us-east-1 type: string webIdentity: $ref: '#/components/schemas/goliothAWSAuthOptionsWebIdentity' type: object goliothAWSProviderOptionsResponse: properties: accessKey: type: string region: title: AWS region, e.g. us-east-1 type: string webIdentity: $ref: '#/components/schemas/goliothAWSAuthOptionsWebIdentity' type: object goliothAddProviderResponse: properties: data: $ref: '#/components/schemas/goliothProvider' type: object goliothArtifact: properties: binaryInfo: type: object blueprintId: type: string createdAt: format: date-time type: string id: type: string package: type: string size: format: uint64 type: string updatedAt: format: date-time type: string version: type: string type: object goliothArtifactUpdate: type: object goliothBlueprint: properties: boardId: type: string createdAt: format: date-time type: string id: type: string name: type: string platform: type: string updatedAt: format: date-time type: string type: object goliothBlueprintUpdate: properties: boardId: type: string name: type: string platform: type: string type: object goliothBlueprintsCreateBody: properties: boardId: type: string name: type: string platform: type: string type: object goliothBoard: properties: arch: type: string id: type: string name: type: string platforms: items: type: string type: array type: object goliothCertificate: properties: certType: type: string certificateContent: $ref: '#/components/schemas/goliothCertificateContent' createdAt: format: date-time type: string demo: type: boolean enabled: type: boolean id: type: string projectId: type: string type: object goliothCertificateContent: properties: issuer: type: string keyUsages: items: type: string type: array notAfter: format: date-time type: string notBefore: format: date-time type: string publicKey: format: byte type: string publicKeyAlgorithm: type: string serialNumber: type: string signature: format: byte type: string signatureAlgorithm: type: string subject: type: string version: format: int64 type: integer type: object goliothCertificatesCreateBody: properties: certFile: format: byte type: string certType: type: string demo: type: boolean type: object goliothCohort: properties: activeDeploymentId: type: string cohortId: type: string createdAt: format: date-time type: string deviceCount: format: int64 type: integer name: type: string updatedAt: format: date-time type: string type: object goliothCohortUpdate: properties: name: type: string type: object goliothCohortsCreateBody: properties: name: type: string type: object goliothConditionalMap: properties: tags: items: type: string type: array type: object goliothCreateAPIKeyResponse: properties: data: $ref: '#/components/schemas/goliothAPIKey' type: object goliothCreateArtifactRequest: properties: blueprintId: type: string content: format: byte type: string package: type: string projectId: type: string version: type: string type: object goliothCreateArtifactResponse: properties: data: $ref: '#/components/schemas/goliothArtifact' type: object goliothCreateBlueprintResponse: properties: data: $ref: '#/components/schemas/goliothBlueprint' type: object goliothCreateCertificateResponse: properties: data: $ref: '#/components/schemas/goliothCertificate' type: object goliothCreateCohortResponse: properties: data: $ref: '#/components/schemas/goliothCohort' type: object goliothCreateCredentialResponse: properties: data: $ref: '#/components/schemas/goliothCredential' type: object goliothCreateCustomerPortalResponse: properties: url: type: string type: object goliothCreateDeploymentResponse: properties: data: $ref: '#/components/schemas/goliothDeployment' type: object goliothCreateDeviceResponse: properties: data: $ref: '#/components/schemas/goliothDevice' type: object goliothCreateIntegrationResponse: properties: data: $ref: '#/components/schemas/goliothIntegration' type: object goliothCreateOrganizationRequest: properties: name: type: string website: type: string type: object goliothCreateOrganizationResponse: properties: data: $ref: '#/components/schemas/goliothOrganization' type: object goliothCreatePKIPolicyResponse: properties: data: $ref: '#/components/schemas/goliothPKIPolicy' type: object goliothCreatePackageResponse: properties: data: $ref: '#/components/schemas/goliothPackage' type: object goliothCreatePipelineResponse: properties: data: $ref: '#/components/schemas/goliothPipeline' type: object goliothCreateProjectRequest: properties: name: type: string organizationId: type: string type: object goliothCreateProjectResponse: properties: data: $ref: '#/components/schemas/goliothProject' type: object goliothCreateReleaseResponse: properties: data: $ref: '#/components/schemas/goliothRelease' type: object goliothCreateSecretResponse: properties: data: $ref: '#/components/schemas/goliothSecret' type: object goliothCreateSettingResponse: properties: data: $ref: '#/components/schemas/goliothSetting' type: object goliothCreateTagResponse: properties: data: $ref: '#/components/schemas/comgoliothTag' type: object goliothCredential: properties: createdAt: format: date-time type: string id: type: string identity: type: string preSharedKey: type: string type: $ref: '#/components/schemas/goliothCredentialType' type: object goliothCredentialType: default: PRE_SHARED_KEY enum: - PRE_SHARED_KEY - ASYMMETRIC_KEY_PAIR type: string goliothCredentialsCreateBody: properties: deviceId: type: string identity: type: string preSharedKey: type: string type: $ref: '#/components/schemas/goliothCredentialType' type: object goliothDeleteAPIKeyResponse: type: object goliothDeleteArtifactResponse: type: object goliothDeleteBlueprintResponse: type: object goliothDeleteCertificateResponse: type: object goliothDeleteCohortResponse: type: object goliothDeleteCredentialResponse: type: object goliothDeleteDeviceResponse: type: object goliothDeleteDeviceStateResponse: type: object goliothDeleteIntegrationResponse: type: object goliothDeletePKIPolicyResponse: type: object goliothDeletePackageResponse: type: object goliothDeletePipelineResponse: type: object goliothDeletePolicyResponse: type: object goliothDeleteProjectResponse: type: object goliothDeleteProviderResponse: type: object goliothDeleteReleaseResponse: type: object goliothDeleteSecretResponse: type: object goliothDeleteSettingResponse: type: object goliothDeleteTagResponse: type: object goliothDeployment: properties: artifactIds: items: type: string type: array createdAt: format: date-time type: string deploymentId: type: string name: type: string type: object goliothDeploymentsCreateBody: properties: artifactIds: items: type: string type: array name: type: string type: object goliothDevice: properties: blueprintId: title: Blueprint ID assigned to the device type: string certificateId: title: Certificate ID assigned to the device, if the device uses certificate-based authentication type: string cohortId: title: Cohort ID of the cohort the device belongs to type: string createdAt: format: date-time title: Timestamp of device creation type: string data: title: Requested device data type: object enabled: title: Whether the device is enabled type: boolean hardwareIds: items: type: string title: List of hardware IDs associated with the device type: array id: title: Unique device ID type: string lastReport: format: date-time title: 'Deprecated: Use metadata.last_report instead' type: string metadata: $ref: '#/components/schemas/goliothDeviceMetadata' name: title: Name of the device type: string status: title: 'Deprecated: Use metadata.status instead' type: string tagIds: items: type: string title: List of tag IDs attached to the device type: array updatedAt: format: date-time title: Timestamp of the last update to the device type: string type: object goliothDeviceActivityLog: properties: deviceId: type: string deviceName: type: string id: type: string lastReport: format: date-time type: string lastSeenOffline: format: date-time type: string lastSeenOnline: format: date-time type: string status: type: string type: object goliothDeviceLogEntry: description: Event generated when a device sends logs. example: device_id: 612d3cecf3ee17d321adbec6 level: 2 message: Hello metadata: {} module: default project_id: esp32-test timestamp: nanos: 250818000 seconds: 1642796612 properties: deviceId: type: string level: $ref: '#/components/schemas/goliothDeviceLogLevel' message: type: string metadata: type: object module: type: string moduleId: type: string timestamp: format: date-time type: string type: $ref: '#/components/schemas/goliothDeviceLogType' type: object goliothDeviceLogLevel: default: NONE enum: - NONE - DEBUG - INFO - WARN - ERROR type: string goliothDeviceLogType: default: LOGGING enum: - LOGGING - DIAGNOSTICS - METRICS type: string goliothDeviceMetadata: properties: lastReport: format: date-time title: Timestamp of latest device activity type: string lastSeenOffline: format: date-time title: Deprecated, use last_seen_online instead type: string lastSeenOnline: format: date-time title: Timestamp of when the device was last seen online type: string lastSettingsStatus: $ref: '#/components/schemas/goliothSettingsStatus' status: title: Deprecated, always returns `-` type: string update: description: Latest Firmware Update information. type: object type: object goliothDeviceStreamQuery: properties: fields: items: $ref: '#/components/schemas/goliothQueryField' type: array filters: items: $ref: '#/components/schemas/goliothQueryFilter' type: array timeBucket: type: string type: object goliothDeviceUpdate: properties: addHardwareId: items: type: string title: Hardware IDs to append for this device type: array addTagId: items: type: string title: Tag IDs to append for this device type: array blueprintId: title: Optional Blueprint ID to assign to the device type: string cohortId: description: 'Optional Cohort ID to assign the device to. Setting to an empty string removes the device from its cohort without assigning it to a new one.' type: string enabled: title: Optionally enable or disable the device type: boolean hardwareIds: items: type: string title: Full list of hardware IDs to set for this device, replacing any existing ones type: array name: title: Optional new name for the device type: string removeHardwareId: items: type: string title: Hardware IDs to remove from this device type: array removeTagId: items: type: string title: Tag IDs to remove from this device type: array tagIds: items: type: string title: Full list of tag IDs to set for this device, replacing any existing ones type: array type: object goliothDevicesCreateBody: properties: blueprintId: title: Optional Blueprint ID to assign to the device type: string cohortId: title: Optional Cohort ID to assign the device to type: string hardwareIds: items: type: string title: Optional list of hardware IDs to add to the device. A single hardware ID will be generated if none are specified type: array name: title: Name of the device. Must be unique within the project type: string tagIds: items: type: string title: Optional list of tag IDs to attach to the device type: array type: object goliothFirmwareLogEntry: properties: deviceId: type: string package: type: string reason: type: string reasonCode: type: string state: type: string stateCode: type: string target: type: string time: format: date-time type: string version: type: string type: object goliothGetArtifactResponse: properties: data: $ref: '#/components/schemas/goliothArtifact' type: object goliothGetBlueprintResponse: properties: data: $ref: '#/components/schemas/goliothBlueprint' type: object goliothGetBoardsResponse: properties: data: $ref: '#/components/schemas/goliothBoard' type: object goliothGetCertificateResponse: properties: data: $ref: '#/components/schemas/goliothCertificate' type: object goliothGetCohortResponse: properties: data: $ref: '#/components/schemas/goliothCohort' type: object goliothGetDeploymentResponse: properties: data: $ref: '#/components/schemas/goliothDeployment' type: object goliothGetDeviceResponse: properties: data: $ref: '#/components/schemas/goliothDevice' type: object goliothGetDeviceStateResponse: properties: data: {} type: object goliothGetDeviceStreamResponse: properties: list: items: {} type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothGetErrorStatsResponse: properties: errors: additionalProperties: $ref: '#/components/schemas/goliothPipelineErrorSummaries' type: object type: object goliothGetIntegrationResponse: properties: data: $ref: '#/components/schemas/goliothIntegration' type: object goliothGetLatestDeviceActivityLogsResponse: properties: list: items: $ref: '#/components/schemas/goliothDeviceActivityLog' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothGetLogsResponse: properties: list: items: $ref: '#/components/schemas/goliothDeviceLogEntry' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothGetOrganizationResponse: properties: data: $ref: '#/components/schemas/goliothOrganization' type: object goliothGetPKIPolicyResponse: properties: data: $ref: '#/components/schemas/goliothPKIPolicy' type: object goliothGetPackageResponse: properties: data: $ref: '#/components/schemas/goliothPackage' type: object goliothGetPipelineResponse: properties: data: $ref: '#/components/schemas/goliothPipeline' type: object goliothGetPolicyResponse: properties: data: $ref: '#/components/schemas/goliothPolicy' type: object goliothGetProjectConfigResponse: properties: data: $ref: '#/components/schemas/goliothProjectConfigSetting' type: object goliothGetProjectResponse: properties: data: $ref: '#/components/schemas/goliothProject' type: object goliothGetProjectStreamResponse: properties: list: items: {} type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothGetProviderResponse: properties: data: $ref: '#/components/schemas/goliothProvider' type: object goliothGetProviderStatusResponse: properties: caCerts: format: int64 type: integer error: type: string id: type: string type: object goliothGetReleaseResponse: properties: data: $ref: '#/components/schemas/goliothRelease' type: object goliothGetSecretResponse: properties: data: $ref: '#/components/schemas/goliothSecret' type: object goliothGetSettingResponse: properties: list: items: $ref: '#/components/schemas/goliothSetting' type: array total: format: int64 type: integer type: object goliothGetTagResponse: properties: data: $ref: '#/components/schemas/comgoliothTag' type: object goliothIntegration: properties: configuration: type: object createdAt: format: date-time type: string enabled: type: boolean id: type: string name: type: string type: type: string updatedAt: format: date-time type: string type: object goliothIntegrationType: properties: attributes: items: $ref: '#/components/schemas/goliothIntegrationTypeAttribute' type: array description: type: string name: type: string type: type: string type: object goliothIntegrationTypeAttribute: properties: description: type: string displayName: type: string name: type: string required: type: boolean type: type: string type: object goliothIntegrationUpdate: properties: configuration: type: object enabled: type: boolean name: type: string type: object goliothIntegrationValidationResponse: type: object goliothIntegrationsCreateBody: properties: configuration: type: object enabled: type: boolean name: type: string type: type: string type: object goliothInviteUserResponse: properties: data: $ref: '#/components/schemas/goliothPolicy' type: object goliothListAPIKeyResponse: properties: list: items: $ref: '#/components/schemas/goliothAPIKey' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListAllowedSettingsDataTypesResponse: properties: list: items: $ref: '#/components/schemas/goliothSettingDataType' type: array total: format: int64 type: integer type: object goliothListArtifactResponse: properties: list: items: $ref: '#/components/schemas/goliothArtifact' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListBlueprintResponse: properties: list: items: $ref: '#/components/schemas/goliothBlueprint' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListBoardsResponse: properties: list: items: $ref: '#/components/schemas/goliothBoard' type: array total: format: int64 type: integer type: object goliothListCertificateResponse: properties: list: items: $ref: '#/components/schemas/goliothCertificate' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListCohortResponse: properties: list: items: $ref: '#/components/schemas/goliothCohort' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListCredentialResponse: properties: list: items: $ref: '#/components/schemas/goliothCredential' type: array type: object goliothListDeploymentResponse: properties: list: items: $ref: '#/components/schemas/goliothDeployment' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListDeviceResponse: properties: list: items: $ref: '#/components/schemas/goliothDevice' title: List of devices type: array page: format: int64 title: Pagination page number type: integer perPage: format: int64 title: Pagination items per page type: integer total: format: int64 title: Total number of devices matching the request type: integer type: object goliothListFirmwareLogsResponse: properties: list: items: $ref: '#/components/schemas/goliothFirmwareLogEntry' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListIntegrationResponse: properties: list: items: $ref: '#/components/schemas/goliothIntegration' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListIntegrationTypesResponse: properties: list: items: $ref: '#/components/schemas/goliothIntegrationType' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListLocationPointsResponse: properties: list: items: $ref: '#/components/schemas/goliothLocationPoint' type: array type: object goliothListNetworkDevicesResponse: properties: list: items: $ref: '#/components/schemas/goliothNetworkDevice' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListNetworksResponse: properties: list: items: $ref: '#/components/schemas/goliothNetwork' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListNotificationsResponse: properties: list: items: $ref: '#/components/schemas/goliothNotification' type: array type: object goliothListOTAEventStatsResponse: properties: endTime: format: date-time type: string list: items: $ref: '#/components/schemas/goliothOTAStatsEventTypeEntry' type: array startTime: format: date-time type: string type: object goliothListOTAEventsResponse: properties: list: items: $ref: '#/components/schemas/goliothOTAEvent' type: array nextPageToken: title: Token to get the next page type: string prevPageToken: title: Token to get the previous page type: string type: object goliothListOrganizationResponse: properties: list: items: $ref: '#/components/schemas/goliothOrganization' type: array type: object goliothListPKIPoliciesResponse: properties: list: items: $ref: '#/components/schemas/goliothPKIPolicy' type: array type: object goliothListPackageResponse: properties: list: items: $ref: '#/components/schemas/goliothPackage' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListPermissionResponse: properties: list: items: $ref: '#/components/schemas/goliothPermission' type: array type: object goliothListPipelineResponse: properties: list: items: $ref: '#/components/schemas/goliothPipelineMetadata' type: array type: object goliothListPolicyResponse: properties: list: items: $ref: '#/components/schemas/goliothPolicy' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListProjectConfigsResponse: properties: list: items: $ref: '#/components/schemas/goliothProjectConfigSetting' type: array type: object goliothListProjectResponse: properties: list: items: $ref: '#/components/schemas/goliothProject' type: array type: object goliothListProviderResponse: properties: list: items: $ref: '#/components/schemas/goliothProvider' type: array type: object goliothListReleaseResponse: properties: list: items: $ref: '#/components/schemas/goliothRelease' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListRoleResponse: properties: list: items: $ref: '#/components/schemas/goliothRole' type: array type: object goliothListSecretsResponse: properties: list: items: $ref: '#/components/schemas/goliothSecret' type: array type: object goliothListSettingResponse: properties: list: items: $ref: '#/components/schemas/goliothSetting' type: array total: format: int64 type: integer type: object goliothListTagResponse: properties: list: items: $ref: '#/components/schemas/comgoliothTag' type: array page: format: int64 type: integer perPage: format: int64 type: integer total: format: int64 type: integer type: object goliothListUsageResponse: properties: dates: additionalProperties: $ref: '#/components/schemas/goliothUsageSummaries' type: object entity: $ref: '#/components/schemas/ListUsageResponseUsageEntity' unit: $ref: '#/components/schemas/goliothUsageUnit' type: object goliothListUsersResponse: properties: list: items: $ref: '#/components/schemas/goliothUser' type: array type: object goliothLocationPoint: properties: accuracy: format: int64 type: integer deviceId: type: string lat: format: double type: number lon: format: double type: number timestamp: format: date-time type: string type: object goliothNetwork: properties: deviceCount: format: int64 type: integer id: type: string lastDevices: items: $ref: '#/components/schemas/goliothRecentDevice' type: array lastSeen: format: date-time type: string type: object goliothNetworkDevice: properties: firstSeenOnGateway: format: date-time type: string gatewayId: type: string id: type: string lastSeen: format: date-time type: string type: object goliothNetworkResponse: properties: data: $ref: '#/components/schemas/goliothNetwork' type: object goliothNotification: properties: id: type: string level: $ref: '#/components/schemas/NotificationLevel' message: type: string scope: type: string timestamp: format: date-time type: string title: type: string type: object goliothOTAEvent: properties: currentVersion: type: string deviceId: type: string eventType: type: string message: type: string packageId: type: string status: format: int32 type: integer targetVersion: type: string timestamp: format: date-time type: string type: object goliothOTAStatsEventTypeCount: properties: count: format: int64 type: integer eventType: type: string type: object goliothOTAStatsEventTypeEntry: properties: duration: format: int64 type: integer stats: items: $ref: '#/components/schemas/goliothOTAStatsEventTypeCount' type: array timestamp: format: date-time type: string type: object goliothOrganization: properties: createdAt: format: date-time type: string id: type: string name: type: string paymentStatus: type: string roles: items: type: string type: array tier: type: string updatedAt: format: date-time type: string website: type: string type: object goliothOrganizationUpdate: properties: name: type: string website: type: string type: object goliothPKIPolicy: properties: createdAt: format: date-time type: string id: type: string providerId: type: string type: type: string updatedAt: format: date-time type: string type: object goliothPackage: properties: createdAt: format: date-time type: string description: type: string metadata: additionalProperties: type: string type: object packageId: type: string updatedAt: format: date-time type: string type: object goliothPackageUpdate: properties: description: type: string metadata: additionalProperties: type: string type: object type: object goliothPackagesCreateBody: properties: description: type: string metadata: additionalProperties: type: string type: object packageId: type: string type: object goliothPermission: properties: action: type: string resource: type: string type: object goliothPipeline: properties: createdAt: format: date-time type: string enabled: type: boolean name: type: string pipeline: format: byte type: string pipelineId: type: string updatedAt: format: date-time type: string type: object goliothPipelineError: properties: error: type: string source: type: string step: format: int32 type: integer timestamp: format: date-time type: string type: type: string type: object goliothPipelineErrorCount: properties: errors: format: int64 type: integer id: type: string type: object goliothPipelineErrorSummaries: properties: errors: items: $ref: '#/components/schemas/goliothPipelineErrorCount' type: array type: object goliothPipelineErrors: properties: errors: items: $ref: '#/components/schemas/goliothPipelineError' type: array type: object goliothPipelineMetadata: properties: createdAt: format: date-time type: string enabled: type: boolean name: type: string pipelineId: type: string updatedAt: format: date-time type: string type: object goliothPipelineUnmatchedData: properties: contentType: type: string path: type: string timestamp: format: date-time type: string type: object goliothPipelineUnmatchedDataResponse: properties: list: items: $ref: '#/components/schemas/goliothPipelineUnmatchedData' type: array type: object goliothPipelineUpdate: properties: enabled: type: boolean name: type: string pipeline: format: byte type: string type: object goliothPipelinesCreateBody: properties: enabled: type: boolean name: type: string pipeline: format: byte type: string type: object goliothPolicy: properties: conditionals: $ref: '#/components/schemas/goliothConditionalMap' createdAt: format: date-time type: string id: type: string resourceId: type: string resourceType: type: string roles: items: type: string type: array updatedAt: format: date-time type: string userId: type: string type: object goliothPolicyUpdate: properties: addRoles: items: type: string type: array addTags: items: type: string type: array removeRoles: items: type: string type: array removeTags: items: type: string type: array roles: items: type: string type: array tagIds: items: type: string type: array type: object goliothProject: properties: createdAt: format: date-time type: string id: type: string name: type: string organizationId: type: string roles: items: type: string type: array updatedAt: format: date-time type: string type: object goliothProjectConfigDisabled: properties: description: type: string reason: type: string type: object goliothProjectConfigSetting: properties: default: $ref: '#/components/schemas/goliothProjectConfigValue' description: type: string disabled: $ref: '#/components/schemas/goliothProjectConfigDisabled' id: type: string name: type: string range: $ref: '#/components/schemas/goliothProjectConfigValueRange' type: type: string updatedAt: format: date-time type: string value: $ref: '#/components/schemas/goliothProjectConfigValue' type: object goliothProjectConfigValue: properties: boolean: type: boolean integer: format: int32 type: integer string: type: string type: object goliothProjectConfigValueRange: properties: max: format: int32 type: integer min: format: int32 type: integer type: object goliothProjectUpdate: properties: name: type: string type: object goliothProvider: properties: aws: $ref: '#/components/schemas/goliothAWSProviderOptionsResponse' createdAt: format: date-time type: string id: type: string updatedAt: format: date-time type: string type: object goliothProviderConfig: properties: aws: $ref: '#/components/schemas/goliothAWSProviderOptions' type: object goliothProvisionData: properties: deviceId: type: string type: object goliothProvisionDeviceResponse: properties: data: $ref: '#/components/schemas/goliothProvisionData' type: object goliothQueryField: properties: agg: type: string alias: type: string path: type: string type: type: string type: object goliothQueryFilter: properties: filters: items: $ref: '#/components/schemas/goliothQueryFilter' type: array op: type: string path: type: string value: {} type: object goliothRecentDevice: properties: id: type: string lastSeen: format: date-time type: string name: type: string type: object goliothRelease: properties: artifactIds: items: type: string type: array blueprintId: type: string cohortId: type: string createdAt: format: date-time type: string deviceTagIds: items: type: string type: array id: type: string releaseTags: items: type: string type: array rollout: type: boolean sequenceNumber: format: int64 type: string suitManifest: type: object updatedAt: format: date-time type: string type: object goliothReleaseUpdate: properties: addDeviceTagId: items: type: string type: array addReleaseTag: items: type: string type: array deviceTagIds: items: type: string type: array releaseTags: items: type: string type: array removeDeviceTagId: items: type: string type: array removeReleaseTag: items: type: string type: array rollout: type: boolean type: object goliothReleasesCreateBody: properties: artifactIds: items: type: string type: array deviceTagIds: items: type: string type: array releaseTags: items: type: string type: array rollout: type: boolean type: object goliothRemoteProcedureCallResponse: properties: detail: {} statusCode: format: int64 type: integer type: object goliothRole: properties: children: items: type: string type: array id: type: string name: type: string permissions: items: $ref: '#/components/schemas/goliothPermission' type: array type: type: string type: object goliothSecret: properties: name: type: string type: $ref: '#/components/schemas/goliothSecretType' type: object goliothSecretType: default: PIPELINE enum: - PIPELINE type: string goliothSecretsCreateBody: properties: name: type: string secret: type: string type: $ref: '#/components/schemas/goliothSecretType' type: object goliothSetProjectConfigResponse: properties: data: $ref: '#/components/schemas/goliothProjectConfigSetting' type: object goliothSetting: properties: blueprintId: type: string createdAt: format: date-time type: string dataType: type: string deviceId: type: string id: type: string key: type: string projectId: type: string updatedAt: format: date-time type: string value: {} type: object goliothSettingDataType: properties: type: type: string type: object goliothSettingError: properties: code: format: int64 title: 'Error code. Possible values: - 0: Sync successful - 1: Key not recognized - 2: Key not valid - 3: Value format not valid - 4: Value outside of allowed range - 5: Value string too long - 6: General error' type: integer codeDescription: title: Human-readable description of the error type: string deviceDetails: title: Optional detailed information about the error provided by the device type: string key: title: Key of the setting that has the error type: string type: object goliothSettingUpdate: properties: value: {} type: object goliothSettingsCreateBody: properties: blueprintId: type: string dataType: type: string deviceId: type: string key: type: string value: {} type: object goliothSettingsStatus: properties: errors: items: $ref: '#/components/schemas/goliothSettingError' title: List of setting errors reported by the device type: array reportedVersion: title: Version of the settings reported by the device, if any type: string status: title: 'Overall status of the settings, if known. Possible values: - "no-settings": There are no settings for this device - "in-sync": The device settings are in sync with the server - "out-of-sync": The device settings are out of sync with the server' type: string statusDetail: title: Optional detailed status message type: string syncTime: format: date-time title: Timestamp of the last settings sync type: string type: object goliothTagUpdate: properties: name: type: string type: object goliothTagsCreateBody: properties: name: type: string type: object goliothTestIntegrationResponse: properties: result: type: string type: object goliothUpdateAPIKeyResponse: properties: data: $ref: '#/components/schemas/goliothAPIKey' type: object goliothUpdateArtifactResponse: properties: data: $ref: '#/components/schemas/goliothArtifact' type: object goliothUpdateBlueprintResponse: properties: data: $ref: '#/components/schemas/goliothBlueprint' type: object goliothUpdateCohortResponse: properties: data: $ref: '#/components/schemas/goliothCohort' type: object goliothUpdateDeviceResponse: properties: data: $ref: '#/components/schemas/goliothDevice' type: object goliothUpdateDeviceStateResponse: properties: data: {} type: object goliothUpdateIntegrationResponse: properties: data: $ref: '#/components/schemas/goliothIntegration' type: object goliothUpdateOrganizationResponse: properties: data: $ref: '#/components/schemas/goliothOrganization' type: object goliothUpdatePKIPolicyResponse: properties: data: $ref: '#/components/schemas/goliothPKIPolicy' type: object goliothUpdatePackageResponse: properties: data: $ref: '#/components/schemas/goliothPackage' type: object goliothUpdatePipelineResponse: properties: data: $ref: '#/components/schemas/goliothPipeline' type: object goliothUpdatePolicyResponse: properties: data: $ref: '#/components/schemas/goliothPolicy' type: object goliothUpdateProjectResponse: properties: data: $ref: '#/components/schemas/goliothProject' type: object goliothUpdateProviderResponse: properties: data: $ref: '#/components/schemas/goliothProvider' type: object goliothUpdateReleaseResponse: properties: data: $ref: '#/components/schemas/goliothRelease' type: object goliothUpdateSettingResponse: properties: data: $ref: '#/components/schemas/goliothSetting' type: object goliothUpdateTagResponse: properties: data: $ref: '#/components/schemas/comgoliothTag' type: object goliothUsageSummaries: properties: summaries: items: $ref: '#/components/schemas/goliothUsageSummary' type: array type: object goliothUsageSummary: properties: id: type: string quantity: format: uint64 type: string service: type: string type: object goliothUsageUnit: default: KILOBYTES enum: - KILOBYTES type: string goliothUser: properties: email: type: string emailVerified: type: boolean id: type: string name: type: string policyId: type: string profileUrl: type: string roles: items: type: string type: array type: object protobufAny: additionalProperties: {} properties: '@type': type: string type: object protobufNullValue: 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." enum: - NULL_VALUE type: string rpcStatus: properties: code: format: int32 type: integer details: items: $ref: '#/components/schemas/protobufAny' type: array message: type: string type: object securitySchemes: API Key: in: header name: x-api-key type: apiKey Bearer: in: header name: Authorization type: apiKey externalDocs: description: golioth API url: https://docs.golioth.io info: title: Golioth Management API version: '1.0' description: 'Golioth IoT Device Management REST API. Authenticate with project-scoped API keys passed in the x-api-key header. Upstream OpenAPI: https://api.golioth.io/openapi.json' openapi: 3.1.0 paths: /v1/artifacts: post: operationId: Artifacts_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCreateArtifactRequest' description: ' (streaming inputs)' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateArtifactResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Artifacts /v1/boards: get: operationId: Boards_List parameters: - in: query name: id schema: type: string - in: query name: platform schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListBoardsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Boards /v1/boards/{id}: get: operationId: Boards_Get parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetBoardsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Boards /v1/integration-types: get: operationId: Integrations_ListIntegrationTypes parameters: - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListIntegrationTypesResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations /v1/organizations: get: operationId: Organizations_List responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListOrganizationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Organizations post: operationId: Organizations_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCreateOrganizationRequest' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateOrganizationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Organizations /v1/organizations/{organizationId}: get: operationId: Organizations_Get parameters: - in: path name: organizationId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetOrganizationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Organizations patch: operationId: Organizations_Update2 parameters: - in: path name: organizationId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothOrganizationUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateOrganizationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Organizations put: operationId: Organizations_Update parameters: - in: path name: organizationId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothOrganizationUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateOrganizationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Organizations /v1/organizations/{organizationId}/customer_portal_sessions: post: operationId: Billing_CreateCustomerPortalSession parameters: - in: path name: organizationId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingCreateCustomerPortalSessionBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateCustomerPortalResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Billing /v1/organizations/{organizationId}/projects/{projectId}/cohorts: get: operationId: Cohorts_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListCohortResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Cohorts post: operationId: Cohorts_Create parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCohortsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateCohortResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Cohorts /v1/organizations/{organizationId}/projects/{projectId}/cohorts/{cohortId}: delete: operationId: Cohorts_Delete parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: cohortId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteCohortResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Cohorts get: operationId: Cohorts_Get parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: cohortId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetCohortResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Cohorts put: operationId: Cohorts_Update parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: cohortId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCohortUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateCohortResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Cohorts /v1/organizations/{organizationId}/projects/{projectId}/cohorts/{cohortId}/deployments: get: operationId: Deployments_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: cohortId required: true schema: type: string - in: query name: name schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListDeploymentResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Deployments post: operationId: Deployments_Create parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: cohortId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothDeploymentsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateDeploymentResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Deployments /v1/organizations/{organizationId}/projects/{projectId}/cohorts/{cohortId}/deployments/{deploymentId}: get: operationId: Deployments_Get parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: cohortId required: true schema: type: string - in: path name: deploymentId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetDeploymentResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Deployments /v1/organizations/{organizationId}/projects/{projectId}/config: get: operationId: ProjectConfig_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListProjectConfigsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Project Config /v1/organizations/{organizationId}/projects/{projectId}/config/{settingId}: get: operationId: ProjectConfig_Get parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: settingId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetProjectConfigResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Project Config put: operationId: ProjectConfig_Set parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: settingId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectConfigSetBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothSetProjectConfigResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Project Config /v1/organizations/{organizationId}/projects/{projectId}/location: get: operationId: Location_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: deviceIds schema: items: type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListLocationPointsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Location /v1/organizations/{organizationId}/projects/{projectId}/networks: get: operationId: Networks_ListNetworks parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListNetworksResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Networks /v1/organizations/{organizationId}/projects/{projectId}/networks/{networkId}: get: operationId: Networks_GetNetwork parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: networkId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothNetworkResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Networks /v1/organizations/{organizationId}/projects/{projectId}/networks/{networkId}/devices: get: operationId: Networks_ListNetworkDevices parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: networkId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListNetworkDevicesResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Networks /v1/organizations/{organizationId}/projects/{projectId}/notifications: get: operationId: Notifications_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: scope schema: type: string - in: query name: level schema: items: enum: - INFO - WARNING - ERROR type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListNotificationsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Notifications /v1/organizations/{organizationId}/projects/{projectId}/ota-events: get: operationId: OTAEvents_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: cohortId schema: type: string - in: query name: packageId schema: type: string - in: query name: deviceId schema: type: string - in: query name: eventType schema: type: string - in: query name: status schema: format: int32 type: integer - in: query name: startTime schema: format: date-time type: string - description: leave out end to get all events up to now in: query name: endTime schema: format: date-time type: string - in: query name: limit schema: format: int64 type: integer - in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListOTAEventsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - OTAEvents /v1/organizations/{organizationId}/projects/{projectId}/ota-events/stats: get: operationId: OTAEvents_ListStats parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: cohortId schema: type: string - in: query name: deviceId schema: type: string - in: query name: startTime schema: format: date-time type: string - description: leave out end to get all events up to now in: query name: endTime schema: format: date-time type: string - in: query name: limit schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListOTAEventStatsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - OTAEvents /v1/organizations/{organizationId}/projects/{projectId}/packages: get: operationId: Packages_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListPackageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Packages post: operationId: Packages_Create parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothPackagesCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreatePackageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Packages /v1/organizations/{organizationId}/projects/{projectId}/packages/{packageId}: delete: operationId: Packages_Delete parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: packageId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeletePackageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Packages get: operationId: Packages_Get parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: packageId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetPackageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Packages put: operationId: Packages_Update parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: packageId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothPackageUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdatePackageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Packages /v1/organizations/{organizationId}/projects/{projectId}/pipeline-unmatched: get: operationId: Pipelines_GetUnmatchedData parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothPipelineUnmatchedDataResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines /v1/organizations/{organizationId}/projects/{projectId}/pipelines: get: operationId: Pipelines_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListPipelineResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines post: operationId: Pipelines_Create parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothPipelinesCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreatePipelineResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines /v1/organizations/{organizationId}/projects/{projectId}/pipelines/errors: get: operationId: Pipelines_GetPipelineErrorStats parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetErrorStatsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines /v1/organizations/{organizationId}/projects/{projectId}/pipelines/{pipelineId}: delete: operationId: Pipelines_Delete parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: pipelineId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeletePipelineResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines get: operationId: Pipelines_Get parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: pipelineId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetPipelineResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines put: operationId: Pipelines_Update parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: pipelineId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothPipelineUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdatePipelineResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines /v1/organizations/{organizationId}/projects/{projectId}/pipelines/{pipelineId}/errors: get: operationId: Pipelines_GetPipelineErrors parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: pipelineId required: true schema: type: string - in: query name: limit schema: format: int64 type: integer - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothPipelineErrors' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Pipelines /v1/organizations/{organizationId}/projects/{projectId}/pki/policies: get: operationId: PKI_ListPKIPolicies parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListPKIPoliciesResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI post: operationId: PKI_CreatePKIPolicy parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PKICreatePKIPolicyBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreatePKIPolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI /v1/organizations/{organizationId}/projects/{projectId}/pki/policies/{policyId}: delete: operationId: PKI_DeletePKIPolicy parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeletePKIPolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI get: operationId: PKI_GetPKIPolicy parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetPKIPolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI put: operationId: PKI_UpdatePKIPolicy parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PKIUpdatePKIPolicyBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdatePKIPolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI /v1/organizations/{organizationId}/projects/{projectId}/pki/providers: get: operationId: PKI_ListProviders parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListProviderResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI post: operationId: PKI_AddProvider parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothProviderConfig' required: true x-originalParamName: config responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothAddProviderResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI /v1/organizations/{organizationId}/projects/{projectId}/pki/providers/{providerId}: delete: operationId: PKI_DeleteProvider parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: providerId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteProviderResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI get: operationId: PKI_GetProvider parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: providerId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetProviderResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI put: operationId: PKI_UpdateProvider parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: providerId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothProviderConfig' required: true x-originalParamName: config responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateProviderResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI /v1/organizations/{organizationId}/projects/{projectId}/pki/providers/{providerId}/status: get: operationId: PKI_GetProviderStatus parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: providerId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetProviderStatusResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - PKI /v1/organizations/{organizationId}/projects/{projectId}/secrets: get: operationId: Secrets_List parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: type schema: default: PIPELINE enum: - PIPELINE type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListSecretsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Secrets post: operationId: Secrets_Create parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothSecretsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateSecretResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Secrets /v1/organizations/{organizationId}/projects/{projectId}/secrets/{name}: delete: operationId: Secrets_Delete parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: name required: true schema: type: string - in: query name: type schema: default: PIPELINE enum: - PIPELINE type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteSecretResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Secrets get: operationId: Secrets_Get parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: name required: true schema: type: string - in: query name: type schema: default: PIPELINE enum: - PIPELINE type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetSecretResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Secrets /v1/organizations/{organizationId}/usage: get: operationId: Usage_ListProjects parameters: - in: path name: organizationId required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListUsageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Usage /v1/organizations/{organizationId}/usage/{projectId}/devices: get: operationId: Usage_ListDevices parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListUsageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Usage /v1/organizations/{organizationId}/usage/{projectId}/devices/{id}: get: operationId: Usage_GetDevice parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: id required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListUsageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Usage /v1/organizations/{organizationId}/usage/{projectId}/pipelines: get: operationId: Usage_ListPipelines parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListUsageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Usage /v1/organizations/{organizationId}/usage/{projectId}/pipelines/{id}: get: operationId: Usage_GetPipeline parameters: - in: path name: organizationId required: true schema: type: string - in: path name: projectId required: true schema: type: string - in: path name: id required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListUsageResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Usage /v1/projects: get: operationId: Projects_List parameters: - in: query name: organizationId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListProjectResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Projects post: operationId: Projects_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCreateProjectRequest' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateProjectResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Projects /v1/projects/{projectId}: delete: operationId: Projects_Delete parameters: - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteProjectResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Projects get: operationId: Projects_Get parameters: - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetProjectResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Projects patch: operationId: Projects_Update2 parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothProjectUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateProjectResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Projects put: operationId: Projects_Update parameters: - in: path name: projectId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothProjectUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateProjectResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Projects /v1/projects/{projectId}/apikeys: get: operationId: APIKeys_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListAPIKeyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - API Keys post: operationId: APIKeys_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothAPIKeysCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateAPIKeyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - API Keys /v1/projects/{projectId}/apikeys/{apikeyId}: delete: operationId: APIKeys_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: apikeyId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteAPIKeyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - API Keys patch: operationId: APIKeys_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: apikeyId required: true schema: type: string - in: query name: name schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothAPIKeyUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateAPIKeyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - API Keys /v1/projects/{projectId}/artifacts: get: operationId: Artifacts_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: version schema: type: string - in: query name: blueprintId schema: type: string - in: query name: package schema: type: string - in: query name: ids schema: items: type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListArtifactResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Artifacts /v1/projects/{projectId}/artifacts/{artifactId}: delete: operationId: Artifacts_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: artifactId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteArtifactResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Artifacts get: operationId: Artifacts_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: artifactId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetArtifactResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Artifacts patch: operationId: Artifacts_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: artifactId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothArtifactUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateArtifactResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Artifacts put: operationId: Artifacts_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: artifactId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothArtifactUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateArtifactResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Artifacts /v1/projects/{projectId}/blueprints: get: operationId: Blueprints_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: blueprintName schema: type: string - in: query name: ids schema: items: type: string type: array - in: query name: boardId schema: type: string - in: query name: platform schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListBlueprintResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Blueprints post: operationId: Blueprints_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothBlueprintsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateBlueprintResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Blueprints /v1/projects/{projectId}/blueprints/{blueprintId}: delete: operationId: Blueprints_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: blueprintId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteBlueprintResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Blueprints get: operationId: Blueprints_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: blueprintId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetBlueprintResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Blueprints patch: operationId: Blueprints_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: blueprintId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothBlueprintUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateBlueprintResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Blueprints put: operationId: Blueprints_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: blueprintId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothBlueprintUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateBlueprintResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Blueprints /v1/projects/{projectId}/certificates: get: operationId: Certificates_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - description: 'TODO: filter by: device_id, enabled/disabled, start/end expiration date, cert type, may increase filters in the future' in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListCertificateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Certificates post: operationId: Certificates_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCertificatesCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateCertificateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Certificates /v1/projects/{projectId}/certificates/{certificateId}: delete: operationId: Certificates_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: certificateId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteCertificateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Certificates get: operationId: Certificates_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: certificateId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetCertificateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Certificates /v1/projects/{projectId}/credentials: post: operationId: Credentials_Create2 parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCredentialsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateCredentialResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Credentials /v1/projects/{projectId}/credentials/{credentialId}: delete: operationId: Credentials_Delete2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: credentialId required: true schema: type: string - in: query name: deviceId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteCredentialResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Credentials /v1/projects/{projectId}/device-activity-logs: get: operationId: Logs_GetLatestDeviceActivityLogs parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetLatestDeviceActivityLogsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Logs /v1/projects/{projectId}/devices: get: description: 'List devices in the project, optionally applying filters and pagination parameters. Devices can be filtered by any property, and additionally filtered by a freetext search term.' operationId: Devices_List parameters: - description: Project ID in: path name: projectId required: true schema: type: string - description: Pagination page number in: query name: page schema: format: int64 type: integer - description: 'Pagination items per page. Must be between 1 and 100 (inclusive). Default is 100.' in: query name: perPage schema: format: int64 type: integer - description: Filter by device name (full match) in: query name: deviceName schema: type: string - description: Filter by hardware ID (full match) in: query name: hardwareId schema: type: string - description: Filter by tag IDs. Devices must have all specified tags. in: query name: tags schema: items: type: string type: array - description: Filter by blueprint ID in: query name: blueprintId schema: type: string - description: Path to device state to include in the response in: query name: statePath schema: type: string - description: Path to device stream data to include in the response in: query name: streamPath schema: type: string - description: Ignored, kept for backward compatibility in: query name: updatePath schema: type: string - description: Partial text search term to filter devices by name or hardware IDs in: query name: term schema: type: string - description: Filter by enabled status in: query name: enabled schema: type: boolean - description: Filter by cohort ID in: query name: cohortId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. summary: List devices in the project tags: - Devices post: description: 'Create a new device with a unique name in an existing project. The tags, blueprint and cohort must already have been created. If no hardware ID is specified, a new hardware ID is generated. The device will also be assigned a unique device ID that can be used to fetch it later.' operationId: Devices_Create parameters: - description: Project ID in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothDevicesCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. summary: Create a new device tags: - Devices /v1/projects/{projectId}/devices/{deviceId}: delete: description: Permanently delete a device and all its data. Data already pushed to other services by this device will not be removed retroactively. operationId: Devices_Delete parameters: - description: Project ID in: path name: projectId required: true schema: type: string - description: Device ID in: path name: deviceId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. summary: Delete a device tags: - Devices get: description: Get a device by its assigned device ID. operationId: Devices_Get parameters: - description: Project ID in: path name: projectId required: true schema: type: string - description: Device ID in: path name: deviceId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. summary: Get a device by its ID tags: - Devices patch: description: 'Use the `PUT` method to replace a device in its entirety, or the `PATCH` method to replace a subset of the device properties. For the `PATCH` method, hardware IDs and tags can be added or removed with the `add_...` and `remove_...` properties respectively, or the entire set of hardware IDs or tags can be replaced by assigning a value to their respective properties.' operationId: Devices_Update2 parameters: - description: Project ID in: path name: projectId required: true schema: type: string - description: Device ID in: path name: deviceId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothDeviceUpdate' description: Update to apply to the device required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. summary: Update a device tags: - Devices put: description: 'Use the `PUT` method to replace a device in its entirety, or the `PATCH` method to replace a subset of the device properties. For the `PATCH` method, hardware IDs and tags can be added or removed with the `add_...` and `remove_...` properties respectively, or the entire set of hardware IDs or tags can be replaced by assigning a value to their respective properties.' operationId: Devices_Update parameters: - description: Project ID in: path name: projectId required: true schema: type: string - description: Device ID in: path name: deviceId required: true schema: type: string - description: Field mask specifying which fields to update (only used for PATCH requests) in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothDeviceUpdate' description: Update to apply to the device required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. summary: Update a device tags: - Devices /v1/projects/{projectId}/devices/{deviceId}/credentials: get: operationId: Credentials_List parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListCredentialResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Credentials post: operationId: Credentials_Create parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothCredentialsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateCredentialResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Credentials /v1/projects/{projectId}/devices/{deviceId}/credentials/{credentialId}: delete: operationId: Credentials_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: path name: credentialId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteCredentialResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Credentials /v1/projects/{projectId}/devices/{deviceId}/data/{path}: delete: operationId: DeviceState_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB get: operationId: DeviceState_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB patch: operationId: DeviceState_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string requestBody: content: application/json: schema: {} required: true x-originalParamName: value responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB post: operationId: DeviceState_Update3 parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string requestBody: content: application/json: schema: {} required: true x-originalParamName: value responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB put: operationId: DeviceState_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string requestBody: content: application/json: schema: {} required: true x-originalParamName: value responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB /v1/projects/{projectId}/devices/{deviceId}/network: get: operationId: Networks_GetDeviceNetwork parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothNetworkResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Networks /v1/projects/{projectId}/devices/{deviceId}/provisioning: post: operationId: Provisioning_ProvisionDevice2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProvisioningProvisionDeviceBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothProvisionDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Provisioning /v1/projects/{projectId}/devices/{deviceId}/rpc: post: operationId: DeviceRemoteProcedureCall_RemoteProcedureCall parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceRemoteProcedureCallRemoteProcedureCallBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothRemoteProcedureCallResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Remote Procedure Call /v1/projects/{projectId}/devices/{deviceId}/settings: get: operationId: Settings_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetSettingResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings /v1/projects/{projectId}/devices/{deviceId}/stream: get: operationId: DeviceStream_GetDeviceStream parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string - in: query name: interval schema: type: string - in: query name: encodedQuery schema: type: string - in: query name: query.timeBucket schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetDeviceStreamResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB Stream post: operationId: DeviceStream_GetDeviceStream2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: deviceId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceStreamGetDeviceStreamBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetDeviceStreamResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB Stream /v1/projects/{projectId}/devicesByTag/{tag}/data/{path}: delete: operationId: DeviceState_DeleteByTag parameters: - in: path name: projectId required: true schema: type: string - in: path name: tag required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB patch: operationId: DeviceState_UpdateByTag2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: tag required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string requestBody: content: application/json: schema: {} required: true x-originalParamName: value responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB post: operationId: DeviceState_UpdateByTag3 parameters: - in: path name: projectId required: true schema: type: string - in: path name: tag required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string requestBody: content: application/json: schema: {} required: true x-originalParamName: value responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB put: operationId: DeviceState_UpdateByTag parameters: - in: path name: projectId required: true schema: type: string - in: path name: tag required: true schema: type: string - in: path name: path required: true schema: pattern: .+ type: string requestBody: content: application/json: schema: {} required: true x-originalParamName: value responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateDeviceStateResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB /v1/projects/{projectId}/firmware/logs: get: operationId: Firmwares_Logs parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: version schema: type: string - in: query name: target schema: type: string - in: query name: state schema: type: string - in: query name: reason schema: type: string - in: query name: deviceId schema: items: type: string type: array - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListFirmwareLogsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Firmware /v1/projects/{projectId}/integrations: get: operationId: Integrations_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: name schema: type: string - in: query name: ids schema: items: type: string type: array - in: query name: type schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations post: operationId: Integrations_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothIntegrationsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations /v1/projects/{projectId}/integrations/validate: post: operationId: Integrations_Validate parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationsValidateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothIntegrationValidationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations /v1/projects/{projectId}/integrations/{integrationId}: delete: operationId: Integrations_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: integrationId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations get: operationId: Integrations_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: integrationId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations patch: operationId: Integrations_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: integrationId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothIntegrationUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations put: operationId: Integrations_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: integrationId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothIntegrationUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations /v1/projects/{projectId}/integrations/{integrationId}/test: post: operationId: Integrations_Test parameters: - in: path name: projectId required: true schema: type: string - in: path name: integrationId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationsTestBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothTestIntegrationResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Integrations /v1/projects/{projectId}/logs: get: operationId: Logs_GetLogs parameters: - in: path name: projectId required: true schema: type: string - in: query name: deviceId schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string - in: query name: module schema: type: string - in: query name: level schema: default: NONE enum: - NONE - DEBUG - INFO - WARN - ERROR type: string - in: query name: term schema: type: string - in: query name: tags schema: items: type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetLogsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Logs /v1/projects/{projectId}/permissions: get: operationId: Access_ListPermissions parameters: - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListPermissionResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access /v1/projects/{projectId}/policies: get: operationId: Access_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: userId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListPolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access /v1/projects/{projectId}/policies/{policyId}: delete: operationId: Access_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeletePolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access get: operationId: Access_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetPolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access patch: operationId: Access_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothPolicyUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdatePolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access put: operationId: Access_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: policyId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothPolicyUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdatePolicyResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access /v1/projects/{projectId}/provisioning: post: operationId: Provisioning_ProvisionDevice parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProvisioningProvisionDeviceBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothProvisionDeviceResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Provisioning /v1/projects/{projectId}/releases: get: operationId: Releases_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: releaseTags schema: items: type: string type: array - in: query name: deviceTags schema: items: type: string type: array - in: query name: ids schema: items: type: string type: array - in: query name: rollout schema: type: boolean - in: query name: blueprintId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListReleaseResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Releases post: operationId: Releases_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothReleasesCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateReleaseResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Releases /v1/projects/{projectId}/releases/{releaseId}: delete: operationId: Releases_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: releaseId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteReleaseResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Releases get: operationId: Releases_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: releaseId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetReleaseResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Releases patch: operationId: Releases_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: releaseId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothReleaseUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateReleaseResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Releases put: operationId: Releases_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: releaseId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothReleaseUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateReleaseResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Releases /v1/projects/{projectId}/settings: get: operationId: Settings_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: blueprintId schema: type: string - in: query name: deviceId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListSettingResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings post: operationId: Settings_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothSettingsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateSettingResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings /v1/projects/{projectId}/settings/{settingId}: delete: operationId: Settings_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: settingId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteSettingResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings patch: operationId: Settings_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: settingId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothSettingUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateSettingResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings put: operationId: Settings_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: settingId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothSettingUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateSettingResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings /v1/projects/{projectId}/stream: get: operationId: DeviceStream_GetProjectStream parameters: - in: path name: projectId required: true schema: type: string - in: query name: start schema: format: date-time type: string - in: query name: end schema: format: date-time type: string - in: query name: interval schema: type: string - in: query name: encodedQuery schema: type: string - in: query name: query.timeBucket schema: type: string - in: query name: deviceId schema: items: type: string type: array - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: tags schema: items: type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetProjectStreamResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB Stream post: operationId: DeviceStream_GetProjectStream2 parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceStreamGetProjectStreamBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetProjectStreamResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - LightDB Stream /v1/projects/{projectId}/tags: get: operationId: Tags_List parameters: - in: path name: projectId required: true schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: perPage schema: format: int64 type: integer - in: query name: tagName schema: type: string - in: query name: ids schema: items: type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListTagResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Tags post: operationId: Tags_Create parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothTagsCreateBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothCreateTagResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Tags /v1/projects/{projectId}/tags/{tagId}: delete: operationId: Tags_Delete parameters: - in: path name: projectId required: true schema: type: string - in: path name: tagId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothDeleteTagResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Tags get: operationId: Tags_Get parameters: - in: path name: projectId required: true schema: type: string - in: path name: tagId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothGetTagResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Tags patch: operationId: Tags_Update2 parameters: - in: path name: projectId required: true schema: type: string - in: path name: tagId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothTagUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateTagResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Tags put: operationId: Tags_Update parameters: - in: path name: projectId required: true schema: type: string - in: path name: tagId required: true schema: type: string - in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/goliothTagUpdate' required: true x-originalParamName: update responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothUpdateTagResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Tags /v1/projects/{projectId}/users: get: operationId: Access_ListUsers parameters: - in: path name: projectId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListUsersResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access /v1/projects/{projectId}/users/invitation: post: operationId: Access_InviteUser parameters: - in: path name: projectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessInviteUserBody' required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothInviteUserResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access /v1/roles: get: operationId: Access_ListRoles responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListRoleResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Access /v1/settings-data-types: get: operationId: Settings_ListAllowedSettingsDataTypes responses: '200': content: application/json: schema: $ref: '#/components/schemas/goliothListAllowedSettingsDataTypesResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. tags: - Settings security: - API Key: [] Bearer: [] servers: - url: https://api.golioth.io