{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server", "version": "v3.36" }, "items": [ { "info": { "name": "ApplicationRegistry", "type": "folder" }, "items": [ { "info": { "name": "List applications where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the application fields that should be returned." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted applications." } ] }, "docs": "List applications where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Update the application, changing the fields specified by the field mask to the provided values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/applications/:application.ids.application_id", "params": [ { "name": "application.ids.application_id", "value": "", "type": "path" } ] }, "docs": "Update the application, changing the fields specified by the field mask to the provided values." }, { "info": { "name": "Get the application with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the application fields that should be returned." } ] }, "docs": "Get the application with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Delete the application. This may not release the application ID for reuse.\nAll end devices must be deleted from the application before it can be deleted.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Delete the application. This may not release the application ID for reuse.\nAll end devices must be deleted from the application before it can be deleted." }, { "info": { "name": "Request DevEUI from the configured address block for a device inside the application.\nThe maximum number of DevEUI's issued per application can be configured.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/applications/:application_id/dev-eui", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Request DevEUI from the configured address block for a device inside the application.\nThe maximum number of DevEUI's issued per application can be configured." }, { "info": { "name": "Purge the application. This will release the application ID for reuse.\nAll end devices must be deleted from the application before it can be deleted.\nThe application owner is responsible for clearing data from any (external) integrations\nthat may store and expose data by application ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_id/purge", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Purge the application. This will release the application ID for reuse.\nAll end devices must be deleted from the application before it can be deleted.\nThe application owner is responsible for clearing data from any (external) integrations\nthat may store and expose data by application ID" }, { "info": { "name": "Restore a recently deleted application.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/applications/:application_id/restore", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Deployment configuration may specify if, and for how long after deletion,\nentities can be restored." }, { "info": { "name": "List applications where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:collaborator.organization_ids.organization_id/applications", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the application fields that should be returned." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted applications." } ] }, "docs": "List applications where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Create a new application. This also sets the given organization or user as\nfirst collaborator with all possible rights.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations/:collaborator.organization_ids.organization_id/applications", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Create a new application. This also sets the given organization or user as\nfirst collaborator with all possible rights." }, { "info": { "name": "List applications where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:collaborator.user_ids.user_id/applications", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the application fields that should be returned." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted applications." } ] }, "docs": "List applications where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Create a new application. This also sets the given organization or user as\nfirst collaborator with all possible rights.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:collaborator.user_ids.user_id/applications", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create a new application. This also sets the given organization or user as\nfirst collaborator with all possible rights." } ] }, { "info": { "name": "ApplicationAccess", "type": "folder" }, "items": [ { "info": { "name": "List the API keys for this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path.\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." } ] }, "docs": "List the API keys for this application." }, { "info": { "name": "Create an API key scoped to this application.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Create an API key scoped to this application." }, { "info": { "name": "Update the rights of an API key of the application.\nThis method can also be used to delete the API key, by giving it no rights.\nThe caller is required to have all assigned or/and removed rights.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys/:api_key.id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "api_key.id", "value": "", "type": "path", "description": "Immutable and unique public identifier for the API key.\nGenerated by the Access Server." } ] }, "docs": "Update the rights of an API key of the application.\nThis method can also be used to delete the API key, by giving it no rights.\nThe caller is required to have all assigned or/and removed rights." }, { "info": { "name": "Get a single API key of this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys/:key_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "key_id", "value": "", "type": "path", "description": "Unique public identifier for the API key." } ] }, "docs": "Get a single API key of this application." }, { "info": { "name": "Delete a single API key of this application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/api-keys/:key_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "key_id", "value": "", "type": "path" } ] }, "docs": "Delete a single API key of this application." }, { "info": { "name": "Get the rights of a collaborator (member) of the application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/organization/:collaborator.organization_ids.organization_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get the rights of a collaborator (member) of the application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "DeleteCollaborator removes a collaborator from an application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/organization/:collaborator_ids.organization_ids.organization_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "collaborator_ids.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator_ids.user_ids.user_id", "value": "", "type": "query", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "DeleteCollaborator removes a collaborator from an application." }, { "info": { "name": "Get the rights of a collaborator (member) of the application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/user/:collaborator.user_ids.user_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Get the rights of a collaborator (member) of the application.\nPseudo-rights in the response (such as the \"_ALL\" right) are not expanded." }, { "info": { "name": "DeleteCollaborator removes a collaborator from an application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborator/user/:collaborator_ids.user_ids.user_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "collaborator_ids.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "collaborator_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "collaborator_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "DeleteCollaborator removes a collaborator from an application." }, { "info": { "name": "List the collaborators on this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborators", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." } ] }, "docs": "List the collaborators on this application." }, { "info": { "name": "Set the rights of a collaborator (member) on the application.\nThis method can also be used to delete the collaborator, by giving them no rights.\nThe caller is required to have all assigned or/and removed rights.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/applications/:application_ids.application_id/collaborators", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Set the rights of a collaborator (member) on the application.\nThis method can also be used to delete the collaborator, by giving them no rights.\nThe caller is required to have all assigned or/and removed rights." }, { "info": { "name": "List the rights the caller has on this application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_id/rights", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "List the rights the caller has on this application." } ] }, { "info": { "name": "AsEndDeviceBatchRegistry", "type": "folder" }, "items": [ { "info": { "name": "Delete a list of devices within the same application.\nThis operation is atomic; either all devices are deleted or none.\nDevices not found are skipped and no error is returned.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/devices/batch", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "device_ids", "value": "", "type": "query" } ] }, "docs": "Delete a list of devices within the same application.\nThis operation is atomic; either all devices are deleted or none.\nDevices not found are skipped and no error is returned." } ] }, { "info": { "name": "AsEndDeviceRegistry", "type": "folder" }, "items": [ { "info": { "name": "Delete deletes the device that matches the given identifiers.\nIf there are multiple matches, an error will be returned.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/devices/:device_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" }, { "name": "dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." } ] }, "docs": "Delete deletes the device that matches the given identifiers.\nIf there are multiple matches, an error will be returned." }, { "info": { "name": "Set creates or updates the device.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device.ids.application_ids.application_id/devices", "params": [ { "name": "end_device.ids.application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Set creates or updates the device." }, { "info": { "name": "Set creates or updates the device.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/as/applications/:end_device.ids.application_ids.application_id/devices/:end_device.ids.device_id", "params": [ { "name": "end_device.ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device.ids.device_id", "value": "", "type": "path" } ] }, "docs": "Set creates or updates the device." }, { "info": { "name": "Get returns the device that matches the given identifiers.\nIf there are multiple matches, an error will be returned.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the end device fields that should be returned.\nSee the API reference for which fields can be returned by the different services." } ] }, "docs": "Get returns the device that matches the given identifiers.\nIf there are multiple matches, an error will be returned." } ] }, { "info": { "name": "AppAs", "type": "folder" }, "items": [ { "info": { "name": "List the items currently in the downlink queue.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/devices/:device_id/down", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" }, { "name": "dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." } ] }, "docs": "List the items currently in the downlink queue." }, { "info": { "name": "Get connection information to connect an MQTT client.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_id/mqtt-connection-info", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Get connection information to connect an MQTT client." }, { "info": { "name": "AppAs_DecodeDownlink", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/down/decode", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" } ] } }, { "info": { "name": "AppAs_EncodeDownlink", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/down/encode", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" } ] } }, { "info": { "name": "Push downlink messages to the end of the downlink queue.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/down/push", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" } ] }, "docs": "Push downlink messages to the end of the downlink queue." }, { "info": { "name": "Replace the entire downlink queue with the specified messages.\nThis can also be used to empty the queue by specifying no messages.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/down/replace", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" } ] }, "docs": "Replace the entire downlink queue with the specified messages.\nThis can also be used to empty the queue by specifying no messages." }, { "info": { "name": "AppAs_DecodeUplink", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/up/decode", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" } ] } }, { "info": { "name": "Simulate an upstream message. This can be used to test integrations.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/up/simulate", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" } ] }, "docs": "Simulate an upstream message. This can be used to test integrations." } ] }, { "info": { "name": "ApplicationPackageRegistry", "type": "folder" }, "items": [ { "info": { "name": "List returns the available packages for the end device.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/devices/:device_id/packages", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" }, { "name": "dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." } ] }, "docs": "List returns the available packages for the end device." }, { "info": { "name": "DeleteDefaultAssociation removes the default association on the FPort of the application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/packages/associations/:f_port", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "f_port", "value": "", "type": "path" } ] }, "docs": "DeleteDefaultAssociation removes the default association on the FPort of the application." }, { "info": { "name": "SetAssociation updates or creates the association on the FPort of the end device.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/as/applications/:association.ids.end_device_ids.application_ids.application_id/devices/:association.ids.end_device_ids.device_id/packages/associations/:association.ids.f_port", "params": [ { "name": "association.ids.end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "association.ids.end_device_ids.device_id", "value": "", "type": "path" }, { "name": "association.ids.f_port", "value": "", "type": "path" } ] }, "docs": "SetAssociation updates or creates the association on the FPort of the end device." }, { "info": { "name": "SetDefaultAssociation updates or creates the default association on the FPort of the application.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/as/applications/:default.ids.application_ids.application_id/packages/associations/:default.ids.f_port", "params": [ { "name": "default.ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "default.ids.f_port", "value": "", "type": "path" } ] }, "docs": "SetDefaultAssociation updates or creates the default association on the FPort of the application." }, { "info": { "name": "DeleteAssociation removes the association on the FPort of the end device.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/packages/associations/:f_port", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" }, { "name": "f_port", "value": "", "type": "path" }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." } ] }, "docs": "DeleteAssociation removes the association on the FPort of the end device." }, { "info": { "name": "ListAssociations returns all of the associations of the end device.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:ids.application_ids.application_id/devices/:ids.device_id/packages/associations", "params": [ { "name": "ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "ids.device_id", "value": "", "type": "path" }, { "name": "ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page.\nEach page is ordered by the FPort." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "field_mask", "value": "", "type": "query" } ] }, "docs": "ListAssociations returns all of the associations of the end device." }, { "info": { "name": "GetDefaultAssociation returns the default association registered on the FPort of the application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:ids.application_ids.application_id/packages/associations/:ids.f_port", "params": [ { "name": "ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "ids.f_port", "value": "", "type": "path" }, { "name": "field_mask", "value": "", "type": "query" } ] }, "docs": "GetDefaultAssociation returns the default association registered on the FPort of the application." }, { "info": { "name": "ListDefaultAssociations returns all of the default associations of the application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:ids.application_id/packages/associations", "params": [ { "name": "ids.application_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page.\nEach page is ordered by the FPort." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." }, { "name": "field_mask", "value": "", "type": "query" } ] }, "docs": "ListDefaultAssociations returns all of the default associations of the application." }, { "info": { "name": "GetAssociation returns the association registered on the FPort of the end device.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:ids.end_device_ids.application_ids.application_id/devices/:ids.end_device_ids.device_id/packages/associations/:ids.f_port", "params": [ { "name": "ids.end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "ids.end_device_ids.device_id", "value": "", "type": "path" }, { "name": "ids.f_port", "value": "", "type": "path" }, { "name": "ids.end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "ids.end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "ids.end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "field_mask", "value": "", "type": "query" } ] }, "docs": "GetAssociation returns the association registered on the FPort of the end device." } ] }, { "info": { "name": "As", "type": "folder" }, "items": [ { "info": { "name": "Get a link configuration from the Application Server to Network Server.\nThis only contains the configuration. Use GetLinkStats to view statistics and any link errors.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/link", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "field_mask", "value": "", "type": "query" } ] }, "docs": "Get a link configuration from the Application Server to Network Server.\nThis only contains the configuration. Use GetLinkStats to view statistics and any link errors." }, { "info": { "name": "Set a link configuration from the Application Server a Network Server.\nThis call returns immediately after setting the link configuration; it does not wait for a link to establish.\nTo get link statistics or errors, use GetLinkStats.\nNote that there can only be one Application Server instance linked to a Network Server for a given application at a time.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/link", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Set a link configuration from the Application Server a Network Server.\nThis call returns immediately after setting the link configuration; it does not wait for a link to establish.\nTo get link statistics or errors, use GetLinkStats.\nNote that there can only be one Application Server instance linked to a Network Server for a given application at a time." }, { "info": { "name": "Delete the link between the Application Server and Network Server for the specified application.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/as/applications/:application_id/link", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "Delete the link between the Application Server and Network Server for the specified application." }, { "info": { "name": "GetLinkStats returns the link statistics.\nThis call returns a NotFound error code if there is no link for the given application identifiers.\nThis call returns the error code of the link error if linking to a Network Server failed.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_id/link/stats", "params": [ { "name": "application_id", "value": "", "type": "path" } ] }, "docs": "GetLinkStats returns the link statistics.\nThis call returns a NotFound error code if there is no link for the given application identifiers.\nThis call returns the error code of the link error if linking to a Network Server failed." }, { "info": { "name": "As_GetConfiguration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/configuration" } } ] }, { "info": { "name": "ApplicationUpStorage", "type": "folder" }, "items": [ { "info": { "name": "Returns a stream of application messages that have been stored in the database.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/packages/storage/:type", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "path", "description": "Query upstream messages of a specific type. If not set, then all upstream messages are returned." }, { "name": "end_device_ids.device_id", "value": "", "type": "query" }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "limit", "value": "", "type": "query", "description": "Limit number of results." }, { "name": "after", "value": "", "type": "query", "description": "Query upstream messages after this timestamp only. Cannot be used in conjunction with last." }, { "name": "before", "value": "", "type": "query", "description": "Query upstream messages before this timestamp only. Cannot be used in conjunction with last." }, { "name": "f_port", "value": "", "type": "query", "description": "Query uplinks on a specific FPort only." }, { "name": "order", "value": "", "type": "query", "description": "Order results." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the upstream message fields that should be returned. See the API reference\nfor allowed field names for each type of upstream message." }, { "name": "last", "value": "", "type": "query", "description": "Query upstream messages that have arrived in the last minutes or hours. Cannot be used in conjunction with after and before." }, { "name": "continuation_token", "value": "", "type": "query", "description": "The continuation token, which is used to retrieve the next page. If provided, other fields are ignored." } ] }, "docs": "Returns a stream of application messages that have been stored in the database." }, { "info": { "name": "Returns how many application messages have been stored in the database for an application or end device.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:application_ids.application_id/packages/storage/:type/count", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "path", "description": "Count upstream messages of a specific type. If not set, then all upstream messages are returned." }, { "name": "end_device_ids.device_id", "value": "", "type": "query" }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "after", "value": "", "type": "query", "description": "Count upstream messages after this timestamp only. Cannot be used in conjunction with last." }, { "name": "before", "value": "", "type": "query", "description": "Count upstream messages before this timestamp only. Cannot be used in conjunction with last." }, { "name": "f_port", "value": "", "type": "query", "description": "Count uplinks on a specific FPort only." }, { "name": "last", "value": "", "type": "query", "description": "Count upstream messages that have arrived in the last minutes or hours. Cannot be used in conjunction with after and before." } ] }, "docs": "Returns how many application messages have been stored in the database for an application or end device." }, { "info": { "name": "Returns a stream of application messages that have been stored in the database.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/packages/storage/:type", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "path", "description": "Query upstream messages of a specific type. If not set, then all upstream messages are returned." }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "limit", "value": "", "type": "query", "description": "Limit number of results." }, { "name": "after", "value": "", "type": "query", "description": "Query upstream messages after this timestamp only. Cannot be used in conjunction with last." }, { "name": "before", "value": "", "type": "query", "description": "Query upstream messages before this timestamp only. Cannot be used in conjunction with last." }, { "name": "f_port", "value": "", "type": "query", "description": "Query uplinks on a specific FPort only." }, { "name": "order", "value": "", "type": "query", "description": "Order results." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the upstream message fields that should be returned. See the API reference\nfor allowed field names for each type of upstream message." }, { "name": "last", "value": "", "type": "query", "description": "Query upstream messages that have arrived in the last minutes or hours. Cannot be used in conjunction with after and before." }, { "name": "continuation_token", "value": "", "type": "query", "description": "The continuation token, which is used to retrieve the next page. If provided, other fields are ignored." } ] }, "docs": "Returns a stream of application messages that have been stored in the database." }, { "info": { "name": "Returns how many application messages have been stored in the database for an application or end device.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/as/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id/packages/storage/:type/count", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "path", "description": "Count upstream messages of a specific type. If not set, then all upstream messages are returned." }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "after", "value": "", "type": "query", "description": "Count upstream messages after this timestamp only. Cannot be used in conjunction with last." }, { "name": "before", "value": "", "type": "query", "description": "Count upstream messages before this timestamp only. Cannot be used in conjunction with last." }, { "name": "f_port", "value": "", "type": "query", "description": "Count uplinks on a specific FPort only." }, { "name": "last", "value": "", "type": "query", "description": "Count upstream messages that have arrived in the last minutes or hours. Cannot be used in conjunction with after and before." } ] }, "docs": "Returns how many application messages have been stored in the database for an application or end device." } ] }, { "info": { "name": "ApplicationActivationSettingRegistry", "type": "folder" }, "items": [ { "info": { "name": "Get returns application activation settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/js/applications/:application_ids.application_id/settings", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "field_mask", "value": "", "type": "query" } ] }, "docs": "Get returns application activation settings." }, { "info": { "name": "Set creates or updates application activation settings.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/js/applications/:application_ids.application_id/settings", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Set creates or updates application activation settings." }, { "info": { "name": "Delete deletes application activation settings.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/js/applications/:application_ids.application_id/settings", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Delete deletes application activation settings." } ] } ], "bundled": true }