Golioth

Golioth Remote Procedure Call API

The Remote Procedure Call API from Golioth — 1 operation(s) for remote procedure call.

Documentation GitHub OpenAPI

Documentation

https://docs.golioth.io/reference/management-api/

https://docs.golioth.io/reference/management-api/auth

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/rate-limits/golioth-rate-limits.yml

Specifications

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/openapi/golioth-remote-procedure-call-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/json-schema/golioth-device-schema.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/json-schema/golioth-release-schema.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/json-schema/golioth-stream-record-schema.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/json-structure/golioth-device-structure.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/json-structure/golioth-release-structure.json

Other Resources

https://api.golioth.io/swagger.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/json-ld/golioth-context.jsonld

SpectralRuleset

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/rules/golioth-rules.yml

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/examples/golioth-create-device-example.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/examples/golioth-create-release-example.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/examples/golioth-invoke-rpc-example.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/examples/golioth-query-stream-example.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/examples/golioth-create-pipeline-example.json

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/plans/golioth-plans-pricing.yml

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/finops/golioth-finops.yml

https://raw.githubusercontent.com/api-evangelist/golioth/refs/heads/main/vocabulary/golioth-vocabulary.yml

OpenAPI Specification

openapi: 3.1.0
info:
  title: Golioth Management Access Remote Procedure Call 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'
servers:
- url: https://api.golioth.io
security:
- API Key: []
  Bearer: []
tags:
- name: Remote Procedure Call
paths:
  /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
components:
  schemas:
    DeviceRemoteProcedureCallRemoteProcedureCallBody:
      properties:
        method:
          type: string
        params:
          items: {}
          type: array
        timeout:
          format: int64
          type: integer
      type: object
    protobufAny:
      additionalProperties: {}
      properties:
        '@type':
          type: string
      type: object
    rpcStatus:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        message:
          type: string
      type: object
    goliothRemoteProcedureCallResponse:
      properties:
        detail: {}
        statusCode:
          format: int64
          type: integer
      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