{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:amazonaws-iot-data/get-thing-shadow":{"get":{"operationId":"cloud_amazonaws_iot_data_get_thing_shadow","summary":"Gets the shadow for the specified thing. Requires permission to access the GetThingShadow action. For more…","description":"GET /things/{thingName}/shadow","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"thingName","in":"query","required":true,"description":"The name of the thing.","schema":{"type":"string","description":"The name of the thing."}},{"name":"name","in":"query","required":false,"description":"The name of the shadow.","schema":{"type":"string","description":"The name of the shadow."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iot-data/update-thing-shadow":{"post":{"operationId":"cloud_amazonaws_iot_data_update_thing_shadow","summary":"Updates the shadow for the specified thing. Requires permission to access the UpdateThingShadow action. For…","description":"POST /things/{thingName}/shadow","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["thingName","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"thingName":{"type":"string","description":"The name of the thing."},"name":{"type":"string","description":"The name of the shadow."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iot-data/delete-thing-shadow":{"post":{"operationId":"cloud_amazonaws_iot_data_delete_thing_shadow","summary":"Deletes the shadow for the specified thing. Requires permission to access the DeleteThingShadow action. For…","description":"DELETE /things/{thingName}/shadow","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["thingName"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"thingName":{"type":"string","description":"The name of the thing."},"name":{"type":"string","description":"The name of the shadow."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iot-data/get-retained-message":{"get":{"operationId":"cloud_amazonaws_iot_data_get_retained_message","summary":"Gets the details of a single retained message for the specified topic. This action returns the message…","description":"GET /retainedMessage/{topic}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"topic","in":"query","required":true,"description":"The topic name of the retained message to retrieve.","schema":{"type":"string","description":"The topic name of the retained message to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iot-data/list-named-shadows-for-thing":{"get":{"operationId":"cloud_amazonaws_iot_data_list_named_shadows_for_thing","summary":"Lists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action.","description":"GET /api/things/shadow/ListNamedShadowsForThing/{thingName}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"thingName","in":"query","required":true,"description":"The name of the thing.","schema":{"type":"string","description":"The name of the thing."}},{"name":"nextToken","in":"query","required":false,"description":"The token to retrieve the next set of results.","schema":{"type":"string","description":"The token to retrieve the next set of results."}},{"name":"pageSize","in":"query","required":false,"description":"The result page size.","schema":{"type":"integer","description":"The result page size."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iot-data/list-retained-messages":{"get":{"operationId":"cloud_amazonaws_iot_data_list_retained_messages","summary":"Lists summary information about the retained messages stored for the account. This action returns only the…","description":"GET /retainedMessage","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"nextToken","in":"query","required":false,"description":"To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.","schema":{"type":"string","description":"To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results."}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return at one time.","schema":{"type":"integer","description":"The maximum number of results to return at one time."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iot-data/publish":{"post":{"operationId":"cloud_amazonaws_iot_data_publish","summary":"Publishes an MQTT message. Requires permission to access the Publish action. For more information about MQTT…","description":"POST /topics/{topic}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["topic","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"topic":{"type":"string","description":"The name of the MQTT topic."},"qos":{"type":"integer","description":"The Quality of Service (QoS) level. The default QoS level is 0."},"retain":{"type":"boolean","description":"A Boolean value that determines whether to set the RETAIN flag when the message is published. Setting the RETAIN flag causes the message…"},"x-amz-mqtt5-user-properties":{"type":"string","description":"A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to…"},"x-amz-mqtt5-payload-format-indicator":{"type":"string","enum":["UNSPECIFIED_BYTES","UTF8_DATA"],"description":"An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API."},"contentType":{"type":"string","description":"A UTF-8 encoded string that describes the content of the publishing message."},"responseTopic":{"type":"string","description":"A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the…"},"x-amz-mqtt5-correlation-data":{"type":"string","description":"The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's…"},"messageExpiry":{"type":"integer","description":"A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}