{ "openapi": "3.1.0", "info": { "title": "IoBeacons API", "version": "1.0.0", "description": "Maps, live data, devices, alerts, satellites and weather for the IoBeacons platform. Send your API key as a bearer token. Errors come back as JSON with an error message you can show to a person.", "contact": { "name": "IoBeacons", "url": "https://iobeacons.com/contact/" } }, "servers": [ { "url": "https://iobeacons.com/maps/api/v1" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "Account", "description": "Check your key, plan and usage." }, { "name": "Maps", "description": "Maps hold layers, a saved view and sharing settings." }, { "name": "Layers", "description": "Layers on a map: your own features or live catalog data." }, { "name": "Features", "description": "Points, lines and polygons inside a layer, as GeoJSON." }, { "name": "Sites", "description": "Places that matter to you, used by reports and weather alerts." }, { "name": "Zones", "description": "Geofences for enter and exit alerts." }, { "name": "Devices", "description": "Vehicles, trackers and sensors, and the positions they send." }, { "name": "Alerts", "description": "Rules that watch zones, sites, devices and live feeds, and the alerts they raise." }, { "name": "Reports", "description": "Site Intelligence Reports for any point." }, { "name": "Catalog", "description": "Live public data layers and address search." }, { "name": "Space", "description": "Satellites and debris: orbital elements, live positions and ground tracks." }, { "name": "Weather", "description": "Moving radar and Doppler winds." }, { "name": "Notes", "description": "Notes pinned to places, satellites and maps, shared with your team." }, { "name": "Findings", "description": "Saved views with a note, which you can share by link." } ], "paths": { "/me": { "get": { "operationId": "me", "tags": [ "Account" ], "summary": "Who this key belongs to", "description": "The workspace, plan and this month's API use for the key you sent. A good first call to check a key works.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/usage": { "get": { "operationId": "usage", "tags": [ "Account" ], "summary": "Usage this month", "description": "Counts of maps, features, devices, zones, rules and sites, plus this month's map views, reports and API calls.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/maps": { "get": { "operationId": "listMaps", "tags": [ "Maps" ], "summary": "List maps", "description": "Every map in the workspace the key can see, newest change first.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MapSummary" } } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createMap", "tags": [ "Maps" ], "summary": "Create a map", "description": "Styles: streets, light, dark, satellite, terrain.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Fleet yard", "style": "streets", "view": { "center": [ -95.99, 36.15 ], "zoom": 11 } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/maps/{id}": { "get": { "operationId": "getMap", "tags": [ "Maps" ], "summary": "Get a map with its layers", "description": "The map, its saved view, every layer with its style, and share links if sharing is on.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "updateMap", "tags": [ "Maps" ], "summary": "Change a map", "description": "Send only what changes: name, description, style, view, settings or visibility (private, team, link, public). Turning on link or public sharing returns share and embed links.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Fleet yard (north)", "visibility": "link" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteMap", "tags": [ "Maps" ], "summary": "Delete a map", "description": "Deletes the map, its layers and their features.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/maps/{id}/duplicate": { "post": { "operationId": "duplicateMap", "tags": [ "Maps" ], "summary": "Copy a map", "description": "Copies the map with all its layers and features.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/maps/{id}/share/reset": { "post": { "operationId": "resetShareLink", "tags": [ "Maps" ], "summary": "Make a new share link", "description": "The old link and embed stop working straight away.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/maps/{id}/upload": { "post": { "operationId": "uploadFile", "tags": [ "Maps" ], "summary": "Upload a file as a new layer", "description": "Send multipart/form-data with a file field (GeoJSON, KML, KMZ, GPX, CSV or a zipped shapefile) and an optional name. CSV rows with addresses are geocoded.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "name": { "type": "string" } }, "required": [ "file" ] } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/maps/{id}/layers": { "post": { "operationId": "createLayer", "tags": [ "Layers" ], "summary": "Add a layer", "description": "kind \"features\" (default) is your own data. kind \"catalog\" with a catalog_key adds a live layer from the catalog, for example \"radar\" or \"earthquakes\".", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The map id.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Depots", "style": { "color": "#2876ee", "radius": 6 } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/layers/{id}": { "patch": { "operationId": "updateLayer", "tags": [ "Layers" ], "summary": "Change a layer", "description": "Name, visible, position, or style (color, opacity, width, radius, mode, field, label, popup, palette).", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Depots", "visible": true, "style": { "color": "#d9781a" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteLayer", "tags": [ "Layers" ], "summary": "Delete a layer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/layers/{id}/export.{format}": { "get": { "operationId": "exportLayer", "tags": [ "Layers" ], "summary": "Download a layer", "description": "The whole layer as a file.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } }, { "name": "format", "in": "path", "required": true, "description": "geojson, csv or kml", "schema": { "type": "string", "enum": [ "geojson", "csv", "kml" ] } } ], "responses": { "200": { "description": "A file." }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/tiles/{layerId}/{z}/{x}/{y}.pbf": { "get": { "operationId": "layerTile", "tags": [ "Layers" ], "summary": "Vector tiles", "description": "Mapbox Vector Tiles for large layers. Point MapLibre or Mapbox GL at https://iobeacons.com/maps/api/v1/tiles/{layerId}/{z}/{x}/{y}.pbf and send the key as a header (transformRequest).", "parameters": [ { "name": "layerId", "in": "path", "required": true, "description": "The layer id.", "schema": { "type": "string" } }, { "name": "z", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A file." }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/layers/{id}/features": { "get": { "operationId": "listFeatures", "tags": [ "Features" ], "summary": "Read features", "description": "A GeoJSON FeatureCollection. Each feature carries its id in properties._id. Up to 20,000 per call; truncated is true when there are more, so ask for a smaller bbox.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The layer id.", "schema": { "type": "string" } }, { "name": "bbox", "in": "query", "required": false, "description": "Only what falls inside west,south,east,north (degrees).", "schema": { "type": "string" }, "example": "-96.1,36.0,-95.8,36.3" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureCollection" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "addFeatures", "tags": [ "Features" ], "summary": "Add features", "description": "Send one GeoJSON Feature or a FeatureCollection. Returns the new ids.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The layer id.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "type": "Feature", "geometry": { "type": "Point", "coordinates": [ -95.99, 36.15 ] }, "properties": { "name": "Depot 4" } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/features/{id}": { "patch": { "operationId": "updateFeature", "tags": [ "Features" ], "summary": "Change a feature", "description": "Send a new geometry, new properties, or both. Properties replace the old ones.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The feature id (a number).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "properties": { "name": "Depot 4 (closed)" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteFeature", "tags": [ "Features" ], "summary": "Delete a feature", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The feature id (a number).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/sites": { "get": { "operationId": "listSites", "tags": [ "Sites" ], "summary": "List sites", "description": "Your places of interest as GeoJSON points.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createSite", "tags": [ "Sites" ], "summary": "Add a site", "description": "Give lon and lat, or an address to look up. An optional boundary polygon is used by weather alerts.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Tulsa yard", "address": "1 W 3rd St, Tulsa, OK" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/sites/{id}": { "patch": { "operationId": "updateSite", "tags": [ "Sites" ], "summary": "Change a site", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Tulsa yard (main)" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteSite", "tags": [ "Sites" ], "summary": "Delete a site", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/zones": { "get": { "operationId": "listZones", "tags": [ "Zones" ], "summary": "List zones", "description": "Geofences as GeoJSON polygons.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createZone", "tags": [ "Zones" ], "summary": "Add a zone", "description": "Send a circle (lon, lat, radius_m) or a GeoJSON Polygon as geometry.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Yard", "circle": { "lon": -95.99, "lat": 36.15, "radius_m": 300 } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/zones/{id}": { "patch": { "operationId": "updateZone", "tags": [ "Zones" ], "summary": "Change a zone", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Main yard", "color": "#d9781a" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteZone", "tags": [ "Zones" ], "summary": "Delete a zone", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/devices": { "get": { "operationId": "listDevices", "tags": [ "Devices" ], "summary": "List devices", "description": "Every device with its last position, plus a FeatureCollection of those that have reported.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createDevice", "tags": [ "Devices" ], "summary": "Add a device", "description": "external_id is your own id for it. You can skip this step: sending positions for a new external id creates the device.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Truck 12", "external_id": "truck-12", "kind": "vehicle" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/devices/{id}": { "delete": { "operationId": "deleteDevice", "tags": [ "Devices" ], "summary": "Delete a device", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/devices/{ref}/positions": { "post": { "operationId": "sendPositions", "tags": [ "Devices" ], "summary": "Send positions", "description": "One fix, or { \"positions\": [...] } with up to 1,000 fixes and their times. The answer lists alerts the new positions set off.", "parameters": [ { "name": "ref", "in": "path", "required": true, "description": "The device id or your external id.", "schema": { "type": "string" }, "example": "truck-12" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "lon": -95.99, "lat": 36.15, "speed_mph": 34, "heading": 90 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/devices/{id}/track": { "get": { "operationId": "deviceTrack", "tags": [ "Devices" ], "summary": "A device's trail", "description": "A GeoJSON LineString of recent positions.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } }, { "name": "hours", "in": "query", "required": false, "description": "How far back, 1 to 168. Default 24.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/rules": { "get": { "operationId": "listRules", "tags": [ "Alerts" ], "summary": "List alert rules", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createRule", "tags": [ "Alerts" ], "summary": "Add an alert rule", "description": "Trigger types: zone_enter, zone_exit, offline, speed, nws_warning, earthquake. Channels: emails, sms (with country code) and https webhooks.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Truck left the yard", "trigger": { "type": "zone_exit", "zone_id": "00000000-0000-0000-0000-000000000000" }, "channels": { "emails": [ "ops@example.com" ], "webhooks": [ "https://example.com/hooks/iobeacons" ] } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/rules/{id}": { "patch": { "operationId": "updateRule", "tags": [ "Alerts" ], "summary": "Change an alert rule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "enabled": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteRule", "tags": [ "Alerts" ], "summary": "Delete an alert rule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/alerts": { "get": { "operationId": "listAlerts", "tags": [ "Alerts" ], "summary": "Recent alerts", "description": "The last 100 alerts and how each was delivered.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports": { "post": { "operationId": "createReport", "tags": [ "Reports" ], "summary": "Make a site report", "description": "Flood zone, weather warnings, earthquakes, nearby services and more for a point or a site_id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "lon": -95.99, "lat": 36.15, "radius_mi": 1 } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "listReports", "tags": [ "Reports" ], "summary": "List reports", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports/{id}": { "get": { "operationId": "getReport", "tags": [ "Reports" ], "summary": "Get a report", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports/{id}/pdf": { "get": { "operationId": "reportPdf", "tags": [ "Reports" ], "summary": "Download a report as PDF", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A file." }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/catalog": { "get": { "operationId": "listCatalog", "tags": [ "Catalog" ], "summary": "List live data layers", "description": "Ready-made layers (weather warnings, radar, earthquakes, wildfires, flood zones and more), with which your plan includes.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/catalog/{key}/data": { "get": { "operationId": "catalogData", "tags": [ "Catalog" ], "summary": "Read a live data layer", "description": "GeoJSON for vector catalog layers, or tile details for raster ones.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "example": "earthquakes" }, { "name": "bbox", "in": "query", "required": false, "description": "Only what falls inside west,south,east,north (degrees).", "schema": { "type": "string" }, "example": "-96.1,36.0,-95.8,36.3" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/geocode": { "get": { "operationId": "geocode", "tags": [ "Catalog" ], "summary": "Look up an address", "parameters": [ { "name": "q", "in": "query", "required": true, "description": "An address or place name.", "schema": { "type": "string" }, "example": "1 W 3rd St, Tulsa" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space": { "get": { "operationId": "spaceGroups", "tags": [ "Space" ], "summary": "List satellite groups", "description": "Stations, weather, Earth observation, GPS, science, Starlink, every active satellite, recent launches and three debris fields.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/{group}": { "get": { "operationId": "spaceGroup", "tags": [ "Space" ], "summary": "Orbital elements for a group", "description": "Two-line elements (TLE) from CelesTrak, refreshed every few hours.", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" }, "example": "stations" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/{group}/positions": { "get": { "operationId": "spaceGroupPositions", "tags": [ "Space" ], "summary": "Where a whole group is", "description": "Every object in the group as GeoJSON points with altitude and speed.", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" }, "example": "stations" }, { "name": "time", "in": "query", "required": false, "description": "A moment within 30 days of now, as an ISO date. Default: now.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/objects/{norad}/position": { "get": { "operationId": "satellitePosition", "tags": [ "Space" ], "summary": "Where one object is", "description": "Longitude, latitude, altitude (km) and speed (km/s), worked out from the latest elements.", "parameters": [ { "name": "norad", "in": "path", "required": true, "description": "NORAD catalogue number.", "schema": { "type": "string" }, "example": "25544" }, { "name": "time", "in": "query", "required": false, "description": "A moment within 30 days of now, as an ISO date. Default: now.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SatellitePosition" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/objects/{norad}/track": { "get": { "operationId": "satelliteTrack", "tags": [ "Space" ], "summary": "Ground track", "description": "The path over the ground as a GeoJSON MultiLineString, split at the date line.", "parameters": [ { "name": "norad", "in": "path", "required": true, "schema": { "type": "string" }, "example": "25544" }, { "name": "time", "in": "query", "required": false, "description": "A moment within 30 days of now, as an ISO date. Default: now.", "schema": { "type": "string", "format": "date-time" } }, { "name": "minutes", "in": "query", "required": false, "description": "How long a path, 1 to 1440. Default: one orbit.", "schema": { "type": "integer" } }, { "name": "step", "in": "query", "required": false, "description": "Seconds between points, 10 to 600. Default 60.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/objects/{norad}/heard": { "get": { "operationId": "satelliteHeard", "tags": [ "Space" ], "summary": "Recordings by ground stations", "description": "Recent passes of this object recorded by SatNOGS, an open network of volunteer ground stations, and checked as good: when, which station and where, frequency, mode, decoded packets, and links to the recording.", "parameters": [ { "name": "norad", "in": "path", "required": true, "description": "NORAD catalogue number.", "schema": { "type": "string" }, "example": "25544" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/check/iss": { "get": { "operationId": "checkIss", "tags": [ "Space" ], "summary": "Check our positions", "description": "Our ISS position next to an independent public tracker at the same moment, and how far apart they are. agrees is true within 25 km.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/space/info/{norad}": { "get": { "operationId": "satelliteInfo", "tags": [ "Space" ], "summary": "Catalogue record", "description": "Owner, launch date and site, type, status, orbit and radar size from the CelesTrak satellite catalogue.", "parameters": [ { "name": "norad", "in": "path", "required": true, "schema": { "type": "string" }, "example": "25544" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/weather/radar-frames": { "get": { "operationId": "radarFrames", "tags": [ "Weather" ], "summary": "Radar loop frames", "description": "Tile URLs for each frame of the last hour, oldest first, ready for a map library.", "parameters": [ { "name": "source", "in": "query", "required": false, "description": "us (high resolution, 5-minute steps) or world (10-minute steps). Default us.", "schema": { "type": "string", "enum": [ "us", "world" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/weather/doppler": { "get": { "operationId": "doppler", "tags": [ "Weather" ], "summary": "Doppler winds near a point", "description": "The nearest NEXRAD radar within about 460 km and tile URLs for its wind velocity.", "parameters": [ { "name": "lon", "in": "query", "required": true, "description": "Longitude.", "schema": { "type": "number" }, "example": -95.99 }, { "name": "lat", "in": "query", "required": true, "description": "Latitude.", "schema": { "type": "number" }, "example": 36.15 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/notes": { "get": { "operationId": "listNotes", "tags": [ "Notes" ], "summary": "List notes", "parameters": [ { "name": "map_id", "in": "query", "required": false, "description": "Only notes on this map.", "schema": { "type": "string" } }, { "name": "norad", "in": "query", "required": false, "description": "Only notes about this satellite.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createNote", "tags": [ "Notes" ], "summary": "Add a note", "description": "A note pins to a place (lng, lat), a satellite (norad) or a whole map. Add map_id to show it on a map.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "body": "Gate 3 floods after heavy rain.", "target": { "kind": "place", "lng": -95.99, "lat": 36.15 } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/notes/{id}": { "patch": { "operationId": "updateNote", "tags": [ "Notes" ], "summary": "Change a note", "description": "An API key can change notes written with an API key.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "body": "Gate 3 floods after heavy rain. Use gate 4." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteNote", "tags": [ "Notes" ], "summary": "Delete a note", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/findings": { "get": { "operationId": "listFindings", "tags": [ "Findings" ], "summary": "List findings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createFinding", "tags": [ "Findings" ], "summary": "Save a finding", "description": "A saved view with a note. kind \"map\" (center, zoom, pitch, bearing, mapId) or \"orbit\" (norad, time, camera). With share: true the answer includes a link anyone can open.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "title": "Storm cell over the north yard", "note": "Moving east at 30 mph.", "kind": "map", "view": { "center": [ -95.99, 36.15 ], "zoom": 9 }, "share": true } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/findings/{id}": { "patch": { "operationId": "updateFinding", "tags": [ "Findings" ], "summary": "Change a finding", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "share": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteFinding", "tags": [ "Findings" ], "summary": "Delete a finding", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Its id (a UUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Something in the request needs fixing; the message says what.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "No API key, or the key was revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Your plan doesn't include this, or a plan limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many calls. See the X-Quota headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "iobm_…", "description": "Create a key in Maps under Settings → API keys." } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string", "description": "A message you can show to a person." } }, "required": [ "error" ] }, "Me": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "plan": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "key": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "quota": { "type": "object", "properties": { "period": { "type": "string" }, "used": { "type": "integer" }, "limit": { "type": [ "integer", "null" ] } } } } }, "MapSummary": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "style": { "type": "string" }, "visibility": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "layer_count": { "type": "integer" } } }, "FeatureCollection": { "type": "object", "properties": { "type": { "const": "FeatureCollection" }, "truncated": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "object" } } } }, "SatellitePosition": { "type": "object", "properties": { "norad": { "type": "integer" }, "name": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "lon": { "type": "number" }, "lat": { "type": "number" }, "altKm": { "type": "number" }, "speedKmS": { "type": "number" }, "periodMin": { "type": "number" }, "tle": { "type": "array", "items": { "type": "string" } } } } } } }