{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs GatewayRegistry API", "version": "v3.36" }, "items": [ { "info": { "name": "GatewayRegistry", "type": "folder" }, "items": [ { "info": { "name": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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}}/gateways", "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 gateway 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 gateways." } ] }, "docs": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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": "POST", "url": "{{baseUrl}}/gateways/filter" }, "docs": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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 gateway, changing the fields specified by the field mask to the provided values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/gateways/:gateway.ids.gateway_id", "params": [ { "name": "gateway.ids.gateway_id", "value": "", "type": "path" } ] }, "docs": "Update the gateway, changing the fields specified by the field mask to the provided values." }, { "info": { "name": "Get the gateway 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}}/gateways/:gateway_ids.gateway_id", "params": [ { "name": "gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "gateway_ids.eui", "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 gateway fields that should be returned." } ] }, "docs": "Get the gateway 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 gateway. This may not release the gateway ID for reuse, but it does release the EUI.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/gateways/:gateway_id", "params": [ { "name": "gateway_id", "value": "", "type": "path" }, { "name": "eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the gateway. This may not release the gateway ID for reuse, but it does release the EUI." }, { "info": { "name": "Purge the gateway. This will release both gateway ID and EUI for reuse.\nThe gateway owner is responsible for clearing data from any (external) integrations\nthat may store and expose data by gateway ID.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/gateways/:gateway_id/purge", "params": [ { "name": "gateway_id", "value": "", "type": "path" }, { "name": "eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Purge the gateway. This will release both gateway ID and EUI for reuse.\nThe gateway owner is responsible for clearing data from any (external) integrations\nthat may store and expose data by gateway ID." }, { "info": { "name": "Restore a recently deleted gateway. This does not restore the EUI,\nas that was released when deleting the gateway.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/gateways/:gateway_id/restore", "params": [ { "name": "gateway_id", "value": "", "type": "path" }, { "name": "eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Deployment configuration may specify if, and for how long after deletion,\nentities can be restored." }, { "info": { "name": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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/gateways", "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 gateway 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 gateways." } ] }, "docs": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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 gateway. 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/gateways", "params": [ { "name": "collaborator.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." } ] }, "docs": "Create a new gateway. This also sets the given organization or user as\nfirst collaborator with all possible rights." }, { "info": { "name": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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/gateways", "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 gateway 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 gateways." } ] }, "docs": "List gateways where the given user or organization is a direct collaborator.\nIf no user or organization is given, this returns the gateways 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 gateway. 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/gateways", "params": [ { "name": "collaborator.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create a new gateway. This also sets the given organization or user as\nfirst collaborator with all possible rights." } ] } ], "bundled": true }