Make GET requests to return a list of your accounts and information about them.
This endpoint can be called without parameters to retrieve all of your accounts/subaccounts, or filtered by a specific account number, ID, or name. These filters also support lists of account numbers, record IDs, or names using the __in filter. When using the __in filter, supply a list of comma-separated values to return only the products with attributes matching those values.
Example URL
https://www.cradlepointecm.com/api/v2/accounts/?id=1127&name=cradlepoint", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Parent account of an account/subaccount", "name": "account", "required": false, "schema": {"type": "string", "x-upstream-type": "in: int
This operation updates an account.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "The ID of the account to PUT", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"$ref": "#/components/requestBodies/accounts_accountsContent"}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/This operation deletes an account.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of the accounts record to delete", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["accounts"]}}, "/activity_logs/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "activity_logs__activities", "summary": "Get information about activity_logs", "description": "Use the activity_logs endpoint to retrieve NCM activity log information.
Example URL
https://www.cradlepointecm.com/api/v2/activity_logs/", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "The ID of your account", "name": "account", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "The exact date/time when the activity log event was created", "name": "created_at__exact", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Less than date/time filtering operator for when the activity log event was created", "name": "created_at__lt", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Less than or equal date/time filtering operator for when the activity log event was created", "name": "created_at__lte", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Greater than date/time filtering operator for when the activity log event was created", "name": "created_at__gt", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Greater than or equal date/time filtering operator for when the activity log event was created", "name": "created_at__gte", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "The exact date/time when the action occurred", "name": "action__timestamp__exact", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Less than date/time filtering operator for when action occurred", "name": "action__timestamp__lt", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Less than or equal date/time filtering operator for when action occurred", "name": "action__timestamp__lte", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Greater than date/time filtering operator for when action occurred", "name": "action__timestamp__gt", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "Greater than or equal date/time filtering operator for when action occurred", "name": "action__timestamp__gte", "required": false, "schema": {"type": "string", "format": "date-time"}}, {"in": "query", "description": "The user ID of the actor who took the action", "name": "actor__id", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "The exact ID of the object for the activity", "name": "object__id", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "The exact ID of the action of the activity", "name": "action__id__exact", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "Type of actor who took the action", "name": "actor__type", "required": false, "schema": {"type": "string", "enum": ["system", "api_key", "router", "sso_user", "access_point"]}}, {"in": "query", "description": "Type of action taken", "name": "action__type", "required": false, "schema": {"type": "string", "enum": ["create", "delete", "update", "request", "report", "register", "unregister", "activate"]}}, {"in": "query", "description": "Type of object the action was taken upon", "name": "object__type", "required": false, "schema": {"type": "string", "enum": ["group", "router", "schedule", "task", "api_key", "net_device", "notifier", "feature_binding", "authorization", "remote_connection", "remote_connection_profile", "remote_lan_management", "access_point", "network"]}}, {"in": "query", "description": "Restricts the number of records returned in a recordset to this value. Max value is 500.", "name": "limit", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Specifies where (an index) in a recordset to begin returning records.", "name": "offset", "required": false, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"data": [{"action": {"after": {"account": {"id": "8432354", "name": "API-created-subaccount"}}, "before": {"account": {"id": "36304", "name": "New Subaccount Name"}}, "id": "ceac0376-675c-11eb-bf0a-56fa34ed58df3", "timestamp": "2021-02-05T02:49:46.696383Z", "type": 3, "type_name": "update"}, "actor": {"email": "actor@email.address", "id": "045fgBd0s344tzah0g", "type": 5, "type_name": "sso_user"}, "object": {"id": "119012951", "role": {"id": "4", "name": "account_read_only"}, "type": 12, "type_name": "authorization", "user": {"email": "user@email.address", "id": "vOAwbBPFbagt12l9"}}}], "meta": {"limit": 20, "next": "https://www.cradlepointecm.com/api/v2/activity_logs/?action__id__lt=8f9db4d2-6a5d-11eb-a58d-5269e9f352ab"}}}}}}, "tags": ["activity logs"]}}, "/alert_push_destinations/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "alert_push_destinations__alert_push_destinations", "summary": "Get information about alert_push_destinations", "description": "
This method retrieves information about your Alert Push Destinations.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Unique ID of an Alert Push Destination", "name": "destination_config_id", "required": false, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}, {"in": "query", "description": "Restricts the number of records returned in a recordset to this value. Max value is 500.", "name": "limit", "required": false, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"data": [{"account": "https://www.cradlepointecm.com/api/v2/accounts/This operation creates a new Alert Push Destination.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Json object containing any of the following fields; name, enabled, endpoint, and authentication.", "required": true}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/This operation updates an Alert Push Destination.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "Unique ID of an Alert Push Destination", "name": "destination_config_id", "required": true, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Json object containing the fields/values to update", "required": true}, "responses": {"200": {"description": "No response was specified"}}, "tags": ["alert push destinations"]}, "delete": {"operationId": "alert_push_destinations__alert_push_destinations_delete_alert_push_destinations_destination_config_id", "summary": "Delete an alert_push_destinations record", "description": "This operation deletes an account.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "Object ID of Alert Push Destination to delete", "name": "destination_config_id", "required": true, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["alert push destinations"]}}, "/alert_rules/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "alert_rules__alert_rules", "summary": "Get information about alert_rules", "description": "Use the GET method on this endpoint to retrieve alert_rules records. Use the available filtering fields to narrow or broaden your search.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Unique ID of an Alert Rule", "name": "alert_config_id", "required": false, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}, {"in": "query", "description": "Parent account", "name": "account", "required": false, "schema": {"type": "string", "x-upstream-type": "url"}}, {"in": "query", "description": "Schedule for sending notifications", "name": "schedule", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "A list of account-identfier ints", "name": "associated_accounts", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "A list of group-identfier ints", "name": "associated_groups", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Alert types to add to the Alert Rule", "name": "filter_criteria", "required": false, "schema": {"type": "string", "x-upstream-type": "json"}}, {"in": "query", "description": "Email dests (list of ints) used for email notifications", "name": "email_destinations", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "HTTP dests (list of timeuuids) for push notifications", "name": "http_destinations", "required": false, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}, {"in": "query", "description": "Last time an Alert Rule was modified", "name": "updated_at", "required": false, "schema": {"type": "string", "x-upstream-type": "timestamp"}}, {"in": "query", "description": "Additional settings for PDP service-overage alerts", "name": "settings", "required": false, "schema": {"type": "string", "x-upstream-type": "json"}}, {"in": "query", "description": "Restricts the number of records returned in a recordset to this value. Max value is 500.", "name": "limit", "required": false, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"data": [{"account": "https://www.cradlepointecm.com/api/v2/accounts/35065/", "alert_config_id": "e81f4500-1e13-11b2-bfff-ffffffffffff", "associated_accounts": [86819, 84906, 86737, 36023, 35065, 84954], "associated_groups": [], "email_destinations": [63944], "external_rules": null, "filter_criteria": {"alert_type__in": ["geofence_proximity_change"]}, "http_destinations": [], "last_summary_ts": "2021-04-27T22:28:45.262710+00:00", "schedule": null, "settings": null, "updated_at": "2021-04-27T22:29:16.096135+00:00"}], "meta": {"limit": 20, "next": null}}}}}}, "tags": ["alert rules"]}, "post": {"operationId": "alert_rules__alert_rules_post_alert_rules", "summary": "Create an alert_rules record", "description": "Use the POST method on this endpoint to create a new alert_rules record. Include the fields/values to add for the record in the 'Content' field as a JSON object.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Json object containing any of the following fields; schedule, associated_accounts, associated_groups, filter_criteria, http_destinations, and settings.", "required": true}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/This operation updates an Alert Rule.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "Unique ID of an Alert Rule", "name": "alert_config_id", "required": true, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Json object containing the fields/values to update. This can contain any of the fields allowed in POST operations", "required": true}, "responses": {"200": {"description": "No response was specified"}}, "tags": ["alert rules"]}, "delete": {"operationId": "alert_rules__alert_rules_delete_alert_rules_alert_config_id", "summary": "Delete an alert_rules record", "description": "This operation deletes an account.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "Object ID of Alert Rule to delete", "name": "alert_config_id", "required": true, "schema": {"type": "string", "x-upstream-type": "timeuuid"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["alert rules"]}}, "/alerts/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "alerts__alerts", "summary": "Get information about alerts", "description": "This method gives alert information with associated id.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Account this alert is related to, or null if the router field has a value", "name": "account", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis method updates a configuration_managers for associated id.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "The ID of the configuration_managers record to modify", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"$ref": "#/components/requestBodies/configuration_managers_configuration_managersContent"}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"0": "value for data at position 0", "1": "value for data at position 1"}}}}}, "tags": ["configuration managers"]}}, "/device_app_bindings/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "device_app_bindings__device_app_bindings", "summary": "Get information about device_app_bindings", "description": "Use the GET method on this endpoint to retrieve device_app_bindings records. Use the available filtering fields to narrow or broaden your search.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Account that owns the object", "name": "account", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis method deletes the device app binding with associated id
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of the device_app_binding record to delete", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["device app bindings"]}}, "/device_app_states/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "device_app_states__device_app_states", "summary": "Get information about device_app_states", "description": "Use the GET method on this endpoint to retrieve device_app_states records. Use the available filtering fields to narrow or broaden your search.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Account that owns the device_app_states object", "name": "account", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis operation gets Firmwares List.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "The ID of a firmwares record", "name": "id", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Filter for ID contains - a comma-separated list of firmwares record IDs", "name": "id__in", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Version of this firmware", "name": "version", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "Filter for version contains - a comma-separated list of versions", "name": "version__in", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "Restricts the number of records returned in a recordset to this value. Max value is 500.", "name": "limit", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Specifies where (an index) in a recordset to begin returning records.", "name": "offset", "required": false, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"data": [{"built_at": "2013-07-02T16:34:08+00:00", "default_configuration": "https://www.cradlepointecm.com/api/v2/firmwares/2/default_configuration/", "expires_at": "2020-01-01T00:00:00+00:00", "hash": "516cdeaef3830f5558eb1276b4f6f573440f4082", "id": "2", "is_deprecated": true, "product": "https://www.cradlepointecm.com/api/v2/products/6/", "released_at": "2013-07-02T16:34:08+00:00", "resource_url": "https://www.cradlepointecm.com/api/v2/firmwares/2/", "uploaded_at": "2013-07-03T17:59:25.035746+00:00", "url": "https://d251cfg5d9gyuq.cloudfront.net/MBR1200B-2013-07-02T16%3A34%3A08.bin", "version": "4.3.2"}], "meta": {"limit": 20, "next": null, "offset": 0, "previous": null}}}}}}, "tags": ["firmwares"]}}, "/forwarding_lan_details/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "forwarding_lan_details__forwarding_lan_details", "summary": "Get information about forwarding_lan_details", "description": "Use the GET method on this endpoint to retrieve forwarding_lan_details records. Use the available filtering fields to narrow or broaden your search.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "ID of the forwarding_lan_details record", "name": "id", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Filter for forwarding_lan_details contains - a comma-separated list of forwarding_lan_details IDs.", "name": "id__in", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis operation updates a group.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "Unique ID of a Group", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Json object containing the group's fields/values to update", "required": true}, "responses": {"200": {"description": "No response was specified"}}, "tags": ["groups"]}, "delete": {"operationId": "groups__groups_delete_groups_id", "summary": "Delete a groups record", "description": "Use the DELETE method on this endpoint to delete a groups record. This method requires the ID of the groups record to delete. Performing a DELETE action removes the record from NetCloud and can't be reversed.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of the groups record to delete", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["groups"]}}, "/historical_locations/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "historical_locations__historical_locations", "summary": "Get information about historical_locations", "description": "Use the GET method on this endpoint to retrieve historical_locations records. Use the available filtering fields to narrow or broaden your search", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "The ID of the router that sent the location data. This parameter is REQUIRED. Only one router ID may be specified per query; you can't provide a list of router IDs to this endpoint.", "name": "router", "required": true, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Return only data points with created_at timestamps AFTER this datetime. If no timezone is specified, UTC is assumed.", "name": "created_at__gt", "required": false, "schema": {"type": "string", "x-upstream-type": "ISO datetime"}}, {"in": "query", "description": "Return only data points with created_at_timeuuid values AFTER this UUID. Using this query parameter causes the query to skip older data points which were recorded before the created_at_timeuuid field was added. A unique ID associated with the created_at timestamp", "name": "created_at_timeuuid__gt", "required": false, "schema": {"type": "string", "x-upstream-type": "UUID"}}, {"in": "query", "description": "Return only data points with created_at timestamps ON OR BEFORE this. If limit is reached first then this parameter does not apply.", "name": "created_at__lte", "required": false, "schema": {"type": "string", "x-upstream-type": "ISO datetime"}}, {"in": "query", "description": "Return no more than this many location data points. If created_at__lte is reached first then this parameter does not apply.", "name": "limit", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Specifies where (an index) in a recordset to begin returning records.", "name": "offset", "required": false, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"created_at": "2021-02-06T21:38:01.447270Z", "ecio": null, "rfband_5g": null, "rsrq_5g": null, "net_device_name": "wwan-60:38:e0:35:f2:96:2_4G-1", "rsrq": null, "mph": 52.71, "signal_percent": null, "sinr": null, "longitude": -116.07866, "dbm": null, "rfband": null, "created_at_timeuuid": "964d01fa-68c3-11eb-8000-000000000000", "latitude": 44.82413, "cinr": null, "carrier_id": null, "sinr_5g": null, "rsrp_5g": null, "summary": null, "rssi": null, "rsrp": null, "accuracy": 2}}}}}, "tags": ["historical locations"]}}, "/api/v3/beta/lan_clients": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "lan_clients__api_v3_beta_lan_clients_list", "description": "Returns a list of lan clients", "summary": "List lan clients", "parameters": [{"name": "filter[hostname]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[network_type]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[router]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "search", "required": false, "in": "query", "description": "The search query param performs a case insensitive substring search on a set of fields.This operation creates a Location.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "JSON describing the locations object to create", "required": true}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/This operation updates Locations.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of the locations record to update", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "JSON describing the locations record field(s) to update", "required": true}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/Use the GET method on this endpoint to retrieve net_device_signal_samples records. Use the available filtering fields to narrow or broaden your search.
Note: There is a 100 device limit for API queries. If you attempt to retrieve records for more than 100 devices in a single query you will receive an error message. If you do not explicitly specify devices, it is assumed that you are trying to pull records for all devices in your account. If you have more than 100 devices in your account then you may query in batches. See the example titled 'Net Device Usage and Signal Samples' on the Sample Code page for details on querying net_device_signal_samples in batches.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "ID of a net device", "name": "net_device", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intUse the GET method on this endpoint to retrieve net_device_usage_samples records. Use the available filtering fields to narrow or broaden your search.
Note: There is a 100 device limit for API queries. If you attempt to retrieve records for more than 100 devices in a single query you will receive an error message. If you do not explicitly specify devices, it is assumed that you are trying to pull records for all devices in your account. If you have more than 100 devices in your account then you may query in batches. See the example titled 'Net Device Usage and Signal Samples' on the Sample Code page for details on querying net_device_signal_samples in batches.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "ID of a net device", "name": "net_device", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis operation reboots a device or a group of devices.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "JSON object representing either the router or group to reboot", "required": true}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"group": "https://www.cradlepointecm.com/api/v2/groups/24/"}}}}}, "tags": ["reboot activity"]}}, "/api/v3/asset_endpoints/regrades": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"tags": ["regrades"], "security": [{"tokenAuth": []}], "summary": "Get a collection of regrades using query parameters", "operationId": "regrades__readCollection", "parameters": [{"name": "filter[action]", "in": "query", "required": true, "schema": {"$ref": "#/components/schemas/regrades_RegradeAction"}}, {"name": "filter[action_id]", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "filter[created_at]", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "filter[error_code]", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "filter[id]", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "filter[mac_address]", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "filter[status]", "in": "query", "required": true, "schema": {"$ref": "#/components/schemas/regrades_RegradeStatus"}}, {"name": "filter[subscription_type]", "in": "query", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "Success", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/regrades_SimpleJsonApiEnvelopeListExternalRegrade"}}, "application/json": {"example": {"data": [{"id": "y2wV9WVQtRbMCs5", "type": "regrades", "attributes": {"action_id": "j2Cf2lca666xHjc", "mac_address": "36a6f4913505", "created_at": "2023-10-05T16:39:32.173613Z", "action": "UPGRADE", "subscription_type": "NC-ZSCALER", "status": "COMPLETED"}, "relationships": {"tenant": {"data": {"id": "0016u00000gzfJH", "type": "tenants"}}}}, {"id": "IhuwrO3BBOQvyjJ", "type": "regrades", "attributes": {"action_id": "j2Cf2lca666xHjc", "mac_address": "220e01f50455", "created_at": "2023-10-05T16:39:32.174061Z", "action": "UPGRADE", "subscription_type": "NC-ZSCALER", "status": "COMPLETED"}, "relationships": {"tenant": {"data": {"id": "0016u00000gzfJH", "type": "tenants"}}}}, {"type": "regrades", "id": "SxiA5c4MVWyDBr4", "attributes": {"action_id": "j2Cf2lca666xHjc", "mac_address": "762e5D162898", "created_at": "2023-10-05T16:39:32.174061Z", "action": "UPGRADE", "subscription_type": "NC-ZSCALER", "status": "FAILED", "error_code": "NO_LICENSES_AVAILABLE"}, "relationships": {"tenant": {"data": {"id": "0016u00000gzfJH", "type": "tenants"}}}}], "included": [{"id": "0016u00000gzyxy", "type": "tenants"}]}}}}, "400": {"description": "Bad Request", "content": {"*/*": {"schema": {"type": "object"}}}}, "402": {"description": "Payment Required", "content": {"*/*": {"schema": {"type": "object"}}}}, "403": {"description": "Forbidden", "content": {"*/*": {"schema": {"type": "object"}}}}, "404": {"description": "Not Found", "content": {"*/*": {"schema": {"type": "object"}}}}, "405": {"description": "Method Not Allowed", "content": {"*/*": {"schema": {"type": "object"}}}}, "406": {"description": "Not Acceptable", "content": {"*/*": {"schema": {"type": "object"}}}}, "409": {"description": "Conflict", "content": {"*/*": {"schema": {"type": "object"}}}}, "412": {"description": "Precondition Failed", "content": {"*/*": {"schema": {"type": "object"}}}}, "415": {"description": "Unsupported Media Type", "content": {"*/*": {"schema": {"type": "object"}}}}, "423": {"description": "Locked", "content": {"*/*": {"schema": {"type": "object"}}}}, "426": {"description": "Upgrade Required", "content": {"*/*": {"schema": {"type": "object"}}}}, "500": {"description": "Internal Server Error", "content": {"*/*": {"schema": {"type": "object"}}}}}}, "post": {"tags": ["regrades"], "security": [{"tokenAuth": []}], "summary": "Creates a list of regrades", "operationId": "regrades__create", "requestBody": {"content": {"application/vnd.api+json;ext=https://jsonapi.org/ext/atomic": {"schema": {"$ref": "#/components/schemas/regrades_AtomicJsonApiEnvelopeExternalRegrade"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/regrades_AtomicJsonApiEnvelopeExternalRegrade"}}, "application/json": {"example": {"atomic:results": [{"data": {"id": "y2wV9WVQtRbMCs5", "type": "regrades", "attributes": {"action_id": "j2Cf2lca666xHjc", "mac_address": "36a6f4913505", "created_at": "2023-10-05T16:39:32.173613Z", "action": "UPGRADE", "subscription_type": "NC-ZSCALER", "status": "RUNNING"}, "relationships": {"tenant": {"data": {"id": "0016u00000gzfJH", "type": "tenants"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/asset_endpoints/regrades/y2wV9WVQtRbMCs5"}}}, {"data": {"id": "IhuwrO3BBOQvyjJ", "type": "regrades", "attributes": {"action_id": "j2Cf2lca666xHjc", "mac_address": "220e01f50455", "created_at": "2023-10-05T16:39:32.174061Z", "action": "UPGRADE", "subscription_type": "NC-ZSCALER", "status": "RUNNING"}, "relationships": {"tenant": {"data": {"id": "0016u00000gzfJH", "type": "tenants"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/asset_endpoints/regrades/IhuwrO3BBOQvyjJ"}}}, {"data": {"type": "regrades", "id": "SxiA5c4MVWyDBr4", "attributes": {"action_id": "j2Cf2lca666xHjc", "mac_address": "762e5D162898", "created_at": "2023-10-05T16:39:32.174061Z", "action": "UPGRADE", "subscription_type": "NC-ZSCALER", "status": "RUNNING"}, "relationships": {"tenant": {"data": {"id": "0016u00000gzfJH", "type": "tenants"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/asset_endpoints/regrades/SxiA5c4MVWyDBr4"}}}]}}}}, "400": {"description": "Bad Request", "content": {"*/*": {"schema": {"type": "object"}}}}, "402": {"description": "Payment Required", "content": {"*/*": {"schema": {"type": "object"}}}}, "403": {"description": "Forbidden", "content": {"*/*": {"schema": {"type": "object"}}}}, "404": {"description": "Not Found", "content": {"*/*": {"schema": {"type": "object"}}}}, "405": {"description": "Method Not Allowed", "content": {"*/*": {"schema": {"type": "object"}}}}, "406": {"description": "Not Acceptable", "content": {"*/*": {"schema": {"type": "object"}}}}, "409": {"description": "Conflict", "content": {"*/*": {"schema": {"type": "object"}}}}, "412": {"description": "Precondition Failed", "content": {"*/*": {"schema": {"type": "object"}}}}, "415": {"description": "Unsupported Media Type", "content": {"*/*": {"schema": {"type": "object"}}}}, "423": {"description": "Locked", "content": {"*/*": {"schema": {"type": "object"}}}}, "426": {"description": "Upgrade Required", "content": {"*/*": {"schema": {"type": "object"}}}}, "500": {"description": "Internal Server Error", "content": {"*/*": {"schema": {"type": "object"}}}}}}}, "/api/v3/asset_endpoints/regrades/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"tags": ["regrades"], "security": [{"tokenAuth": []}], "summary": "Get one regrade by ID", "operationId": "regrades__readOne", "parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/regrades_SimpleJsonApiEnvelopeExternalRegrade"}}}}, "400": {"description": "Bad Request", "content": {"*/*": {"schema": {"type": "object"}}}}, "402": {"description": "Payment Required", "content": {"*/*": {"schema": {"type": "object"}}}}, "403": {"description": "Forbidden", "content": {"*/*": {"schema": {"type": "object"}}}}, "404": {"description": "Not Found", "content": {"*/*": {"schema": {"type": "object"}}}}, "405": {"description": "Method Not Allowed", "content": {"*/*": {"schema": {"type": "object"}}}}, "406": {"description": "Not Acceptable", "content": {"*/*": {"schema": {"type": "object"}}}}, "409": {"description": "Conflict", "content": {"*/*": {"schema": {"type": "object"}}}}, "412": {"description": "Precondition Failed", "content": {"*/*": {"schema": {"type": "object"}}}}, "415": {"description": "Unsupported Media Type", "content": {"*/*": {"schema": {"type": "object"}}}}, "423": {"description": "Locked", "content": {"*/*": {"schema": {"type": "object"}}}}, "426": {"description": "Upgrade Required", "content": {"*/*": {"schema": {"type": "object"}}}}, "500": {"description": "Internal Server Error", "content": {"*/*": {"schema": {"type": "object"}}}}}}}, "/api/v3/lan_manager_options": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "remote_connect_lan_manager__lan_manager_options_list", "description": "List LAN Manager options. Supports filtering by router and enabled status, with cursor-based pagination.", "parameters": [{"name": "filter[enabled]", "required": false, "in": "query", "description": "Filter by enabled status. Accepts only 'true' or 'false'.", "schema": {"type": "string", "enum": ["true", "false"]}}, {"name": "filter[router]", "required": false, "in": "query", "description": "Filter by router ID.", "schema": {"type": "integer"}}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}], "tags": ["remote connect lan manager"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PaginatedLanManagerOptionList"}}}, "description": "Successful response."}}, "summary": "Get lan manager options"}, "post": {"operationId": "remote_connect_lan_manager__lan_manager_options_create", "description": "Create a new LAN Manager option. The `enabled` attribute must be `true` on creation. A 409 Conflict is returned if a LAN Manager option already exists for the specified router.", "tags": ["remote connect lan manager"], "requestBody": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_LanManagerOptionPostRequest"}}}, "required": true}, "security": [{"tokenAuth": []}], "responses": {"201": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_LanManagerOptionResponse"}}}, "description": "Resource created."}, "400": {"description": "Validation error (e.g. enabled must be true on creation)."}, "403": {"description": "Forbidden."}, "409": {"description": "Conflict. A LAN Manager option already exists for this router."}}, "summary": "Create lan manager options"}}, "/api/v3/lan_manager_options/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "remote_connect_lan_manager__lan_manager_options_retrieve", "description": "Retrieve a LAN Manager option by ID.", "parameters": [{"in": "path", "name": "id", "schema": {"type": "integer"}, "description": "A unique integer value identifying this LAN Manager option.", "required": true}], "tags": ["remote connect lan manager"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_LanManagerOptionResponse"}}}, "description": "Successful response."}, "404": {"description": "Not found."}}, "summary": "Get lan manager options by ID"}, "put": {"operationId": "remote_connect_lan_manager__lan_manager_options_update", "description": "Update an existing LAN Manager option. The router and account relationships cannot be changed.", "parameters": [{"in": "path", "name": "id", "schema": {"type": "integer"}, "description": "A unique integer value identifying this LAN Manager option.", "required": true}], "tags": ["remote connect lan manager"], "requestBody": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_LanManagerOptionPutRequest"}}}, "required": true}, "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_LanManagerOptionResponse"}}}, "description": "Successful response."}, "400": {"description": "Validation error or attempting to change immutable relationships."}, "403": {"description": "Forbidden."}, "404": {"description": "Not found."}}, "summary": "Update lan manager options by ID"}}, "/api/v3/remote_connect_profiles": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "remote_connect_lan_manager__remote_connect_profiles_list", "description": "List remote connect profiles. Supports filtering by type, router, name, and address. Supports sorting and cursor-based pagination.", "parameters": [{"name": "filter[address]", "required": false, "in": "query", "description": "Filter by IPv4 address (exact match). Must be a valid IPv4 address.", "schema": {"type": "string", "format": "ipv4"}}, {"name": "filter[name]", "required": false, "in": "query", "description": "Filter by profile name (exact match).", "schema": {"type": "string"}}, {"name": "filter[router]", "required": false, "in": "query", "description": "Filter by router ID.", "schema": {"type": "integer"}}, {"name": "filter[type]", "required": false, "in": "query", "description": "Filter by profile type. Accepts full type name (e.g. 'remote_connect_ssh_profile') or short form (e.g. 'ssh_profile').", "schema": {"type": "string", "enum": ["remote_connect_ssh_profile", "remote_connect_http_profile", "remote_connect_https_profile", "remote_connect_rdp_profile", "remote_connect_vnc_profile", "remote_connect_serial_profile"]}}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "sort", "required": false, "in": "query", "description": "Sort field. Prefix with '-' for descending order.", "schema": {"type": "array", "items": {"type": "string", "enum": ["id", "-id", "name", "-name", "address", "-address", "port", "-port"]}}, "explode": false}], "tags": ["remote connect lan manager"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PaginatedPolymorphicProfileList"}}}, "description": "Successful response."}}, "summary": "Get remote connect profiles"}, "post": {"operationId": "remote_connect_lan_manager__remote_connect_profiles_create", "description": "Create a remote connect profile. The `type` field in the request body determines which profile type is created and which attributes are required.\n\nPrerequisite: LAN Manager must be enabled for the target router.\n\nRDP and VNC profiles require an Advanced Add-On plan feature binding.\n\nProfile types and their required attributes:\n- \n\n| Type | Required fields | Optional fields |\n|---|---|---|\n| `remote_connect_ssh_profile` | name, port, address, username | \u2014 |\n| `remote_connect_http_profile` | name, port, address | \u2014 |\n| `remote_connect_https_profile` | name, port, address | \u2014 |\n| `remote_connect_rdp_profile` | name, port, address, resolution | username |\n| `remote_connect_vnc_profile` | name, port, address | username |\n| `remote_connect_serial_profile` | name, port (1-8) | \u2014 (no address) |\n\n**Prerequisite:** LAN Manager must be enabled.", "tags": ["remote connect lan manager"], "requestBody": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PolymorphicProfilePostRequest"}, "examples": {"ssh": {"summary": "Create SSH Profile", "value": {"data": {"type": "string", "attributes": {"name": "Office SSH", "port": 22, "address": "192.168.1.100", "username": "admin"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "x-upstream-type": "remote_connect_ssh_profile"}}}, "http": {"summary": "Create HTTP Profile", "value": {"data": {"type": "string", "attributes": {"name": "Web Server", "port": 80, "address": "192.168.1.50"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_http_profile"}}}, "https": {"summary": "Create HTTPS Profile", "value": {"data": {"type": "string", "attributes": {"name": "Secure Web Server", "port": 443, "address": "192.168.1.51"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_https_profile"}}}, "rdp": {"summary": "Create RDP Profile", "value": {"data": {"type": "string", "attributes": {"name": "Remote Desktop", "port": 3389, "address": "192.168.1.200", "username": "rdpuser", "resolution": "1920x1080"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_rdp_profile"}}}, "vnc": {"summary": "Create VNC Profile", "value": {"data": {"type": "string", "attributes": {"name": "VNC Display", "port": 5900, "address": "192.168.1.150", "username": "viewer"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_vnc_profile"}}}, "serial": {"summary": "Create Serial Profile", "value": {"data": {"type": "string", "attributes": {"name": "Console Port", "port": 1}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_serial_profile"}}}}}}, "required": true}, "security": [{"tokenAuth": []}], "responses": {"201": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PolymorphicProfileResponse"}, "examples": {"ssh_response": {"summary": "SSH Profile Response", "value": {"data": {"type": "string", "id": "42", "attributes": {"name": "Office SSH", "port": 22, "address": "192.168.1.100", "username": "admin", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/42"}, "x-upstream-type": "remote_connect_ssh_profile"}}}, "http_response": {"summary": "HTTP Profile Response", "value": {"data": {"type": "string", "id": "43", "attributes": {"name": "Web Server", "port": 80, "address": "192.168.1.50", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/43"}, "x-upstream-type": "remote_connect_http_profile"}}}, "https_response": {"summary": "HTTPS Profile Response", "value": {"data": {"type": "string", "id": "44", "attributes": {"name": "Secure Web Server", "port": 443, "address": "192.168.1.51", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/44"}, "x-upstream-type": "remote_connect_https_profile"}}}, "rdp_response": {"summary": "RDP Profile Response", "value": {"data": {"type": "string", "id": "45", "attributes": {"name": "Remote Desktop", "port": 3389, "address": "192.168.1.200", "username": "rdpuser", "resolution": "1920x1080", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/45"}, "x-upstream-type": "remote_connect_rdp_profile"}}}, "vnc_response": {"summary": "VNC Profile Response", "value": {"data": {"type": "string", "id": "46", "attributes": {"name": "VNC Display", "port": 5900, "address": "192.168.1.150", "username": "viewer", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/46"}, "x-upstream-type": "remote_connect_vnc_profile"}}}, "serial_response": {"summary": "Serial Profile Response", "value": {"data": {"type": "string", "id": "47", "attributes": {"name": "Console Port", "port": 1, "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/47"}, "x-upstream-type": "remote_connect_serial_profile"}}}}}}, "description": "Profile created."}, "400": {"description": "Validation error or LAN Manager not enabled."}, "403": {"description": "Forbidden or missing required feature binding (RDP/VNC)."}}, "summary": "Create remote connect profiles"}}, "/api/v3/remote_connect_profiles/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "remote_connect_lan_manager__remote_connect_profiles_retrieve", "description": "Retrieve a remote connect profile by ID.", "parameters": [{"in": "path", "name": "id", "schema": {"type": "integer"}, "description": "A unique integer value identifying this profile.", "required": true}], "tags": ["remote connect lan manager"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PolymorphicProfileResponse"}, "examples": {"ssh_response": {"summary": "SSH Profile", "value": {"data": {"type": "string", "id": "42", "attributes": {"name": "Office SSH", "port": 22, "address": "192.168.1.100", "username": "admin", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/42"}, "x-upstream-type": "remote_connect_ssh_profile"}}}, "http_response": {"summary": "HTTP Profile", "value": {"data": {"type": "string", "id": "43", "attributes": {"name": "Web Server", "port": 80, "address": "192.168.1.50", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/43"}, "x-upstream-type": "remote_connect_http_profile"}}}, "https_response": {"summary": "HTTPS Profile", "value": {"data": {"type": "string", "id": "44", "attributes": {"name": "Secure Web", "port": 443, "address": "192.168.1.51", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/44"}, "x-upstream-type": "remote_connect_https_profile"}}}, "rdp_response": {"summary": "RDP Profile", "value": {"data": {"type": "string", "id": "45", "attributes": {"name": "Remote Desktop", "port": 3389, "address": "192.168.1.200", "username": "rdpuser", "resolution": "1920x1080", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/45"}, "x-upstream-type": "remote_connect_rdp_profile"}}}, "vnc_response": {"summary": "VNC Profile", "value": {"data": {"type": "string", "id": "46", "attributes": {"name": "VNC Display", "port": 5900, "address": "192.168.1.150", "username": "viewer", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/46"}, "x-upstream-type": "remote_connect_vnc_profile"}}}, "serial_response": {"summary": "Serial Profile", "value": {"data": {"type": "string", "id": "47", "attributes": {"name": "Console Port", "port": 1, "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T12:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/47"}, "x-upstream-type": "remote_connect_serial_profile"}}}}}}, "description": "Successful response."}, "404": {"description": "Not found."}}, "summary": "Get remote connect profiles by ID"}, "put": {"operationId": "remote_connect_lan_manager__remote_connect_profiles_update", "description": "Update a remote connect profile. The `type` field determines which profile type schema is used for validation.\n\nThe profile type, router, and account relationships cannot be changed.\n\nPrerequisite: LAN Manager must be enabled for the router.\n\nRDP and VNC profiles require an Advanced Add-On plan feature binding.", "parameters": [{"in": "path", "name": "id", "schema": {"type": "integer"}, "description": "A unique integer value identifying this profile.", "required": true}], "tags": ["remote connect lan manager"], "requestBody": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PolymorphicProfilePutRequest"}, "examples": {"ssh": {"summary": "Update SSH Profile", "value": {"data": {"type": "string", "id": "42", "attributes": {"name": "Office SSH Updated", "port": 2222, "address": "192.168.1.101", "username": "newadmin"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_ssh_profile"}}}, "http": {"summary": "Update HTTP Profile", "value": {"data": {"type": "string", "id": "43", "attributes": {"name": "Web Server Updated", "port": 8080, "address": "192.168.1.55"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_http_profile"}}}, "https": {"summary": "Update HTTPS Profile", "value": {"data": {"type": "string", "id": "44", "attributes": {"name": "Secure Web Updated", "port": 8443, "address": "192.168.1.56"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_https_profile"}}}, "rdp": {"summary": "Update RDP Profile", "value": {"data": {"type": "string", "id": "45", "attributes": {"name": "Remote Desktop Updated", "port": 3389, "address": "192.168.1.201", "username": "rdpuser", "resolution": "1680x1050"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_rdp_profile"}}}, "vnc": {"summary": "Update VNC Profile", "value": {"data": {"type": "string", "id": "46", "attributes": {"name": "VNC Display Updated", "port": 5901, "address": "192.168.1.151", "username": "newviewer"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_vnc_profile"}}}, "serial": {"summary": "Update Serial Profile", "value": {"data": {"type": "string", "id": "47", "attributes": {"name": "Console Port Updated", "port": 2}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}}, "x-upstream-type": "remote_connect_serial_profile"}}}}}}, "required": true}, "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/remote_connect_lan_manager_PolymorphicProfileResponse"}, "examples": {"ssh_response": {"summary": "SSH Profile Updated", "value": {"data": {"type": "string", "id": "42", "attributes": {"name": "Office SSH Updated", "port": 2222, "address": "192.168.1.101", "username": "newadmin", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T13:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/42"}, "x-upstream-type": "remote_connect_ssh_profile"}}}, "http_response": {"summary": "HTTP Profile Updated", "value": {"data": {"type": "string", "id": "43", "attributes": {"name": "Web Server Updated", "port": 8080, "address": "192.168.1.55", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T13:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/43"}, "x-upstream-type": "remote_connect_http_profile"}}}, "https_response": {"summary": "HTTPS Profile Updated", "value": {"data": {"type": "string", "id": "44", "attributes": {"name": "Secure Web Updated", "port": 8443, "address": "192.168.1.56", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T13:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/44"}, "x-upstream-type": "remote_connect_https_profile"}}}, "rdp_response": {"summary": "RDP Profile Updated", "value": {"data": {"type": "string", "id": "45", "attributes": {"name": "Remote Desktop Updated", "port": 3389, "address": "192.168.1.201", "username": "rdpuser", "resolution": "1680x1050", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T13:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/45"}, "x-upstream-type": "remote_connect_rdp_profile"}}}, "vnc_response": {"summary": "VNC Profile Updated", "value": {"data": {"type": "string", "id": "46", "attributes": {"name": "VNC Display Updated", "port": 5901, "address": "192.168.1.151", "username": "newviewer", "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T13:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/46"}, "x-upstream-type": "remote_connect_vnc_profile"}}}, "serial_response": {"summary": "Serial Profile Updated", "value": {"data": {"type": "string", "id": "47", "attributes": {"name": "Console Port Updated", "port": 2, "created_at": "2026-03-20T12:00:00Z", "updated_at": "2026-03-20T13:00:00Z"}, "relationships": {"router": {"data": {"type": "string", "id": "12345", "x-upstream-type": "routers"}}, "account": {"data": {"type": "string", "id": "4", "x-upstream-type": "accounts"}}}, "links": {"self": "https://api.cradlepointecm.com/api/v3/remote_connect_profiles/47"}, "x-upstream-type": "remote_connect_serial_profile"}}}}}}, "description": "Profile updated."}, "400": {"description": "Validation error, LAN Manager not enabled, or attempting to change immutable fields (type, router, account)."}, "403": {"description": "Forbidden or missing required feature binding (RDP/VNC)."}, "404": {"description": "Not found."}}, "summary": "Update remote connect profiles by ID"}, "delete": {"operationId": "remote_connect_lan_manager__remote_connect_profiles_destroy", "description": "Delete a remote connect profile.", "parameters": [{"in": "path", "name": "id", "schema": {"type": "integer"}, "description": "A unique integer value identifying this profile.", "required": true}], "tags": ["remote connect lan manager"], "security": [{"tokenAuth": []}], "responses": {"204": {"description": "No response body."}, "403": {"description": "Forbidden."}, "404": {"description": "Not found."}}, "summary": "Delete remote connect profiles by ID"}}, "/router_alerts/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "router_alerts__router_alerts", "summary": "Get information about router_alerts", "description": "Use the GET method on this endpoint to retrieve router_alerts records. Use the available filtering fields to narrow or broaden your search.
Note: There is a 100 device limit for API queries. If you attempt to retrieve records for more than 100 devices in a single query you will receive an error message. If you do not explicitly specify devices, it is assumed that you are trying to pull records for all devices in your account. If you have more than 100 devices in your account then you may query in batches. See the example titled 'Net Device Usage and Signal Samples' on the Sample Code page for details on querying in batches.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Router ID", "name": "router", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intUse the GET method on this endpoint to retrieve router_logs records. Use the available filtering fields to narrow or broaden your search.
Note: To receive router logs, you must enable them on the Groups page in NCM using the Settings dialog and selecting the Enable Log Reporting option. Enabling device logs can significantly increase the NCM network traffic from the device to the server depending on how quickly the device is generating log events.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "ID of the Router to retrieve logs from", "name": "router", "required": true, "schema": {"type": "string", "x-upstream-type": "in: intUse the GET method on this endpoint to retrieve router_state_samples records. Use the available filtering fields to narrow or broaden your search. This endpoint provides information about the connection state of a device with NetCloud servers.
Note: There is a 100 device limit for API queries. If you attempt to retrieve records for more than 100 devices in a single query you will receive an error message. If you do not explicitly specify devices, it is assumed that you are trying to pull records for all devices in your account. If you have more than 100 devices in your account then you may query in batches. See the example titled 'Net Device Usage and Signal Samples' on the Sample Code page for details on querying net_device_signal_samples in batches.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Router ID", "name": "router", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intUse the GET method on this endpoint to retrieve router_stream_usage_samples records. Use the available filtering fields to narrow or broaden your search.
Note: There is a 100 device limit for API queries. If you attempt to retrieve records for more than 100 devices in a single query you will receive an error message. If you do not explicitly specify devices, it is assumed that you are trying to pull records for all devices in your account. If you have more than 100 devices in your account then you may query in batches. See the example titled 'Net Device Usage and Signal Samples' on the Sample Code page for details on querying in batches.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Router ID", "name": "router", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis method gives device information with associated id.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "Account that owns the routers record object", "name": "account", "required": false, "schema": {"type": "string", "x-upstream-type": "in: intThis method deletes device information with associated id
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of router record to delete", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["routers"]}}, "/speed_test/{id}/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "speed_test__speed_test", "summary": "Get speed tests information", "description": "Gets the results of a speed test job. The results are updated with the latest known state of the speed tests.
Example URL
https://www.cradlepointecm.com/api/v2/speed_test/{id}/", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of the speed test", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/1/", "config": {"host": "YOURTESTSERVER.COM", "max_test_concurrency": 5, "net_device_ids": [12345678], "port": 12865, "size": null, "test_timeout": 10, "test_type": "TCP Download", "time": 10}, "created_at": "2019-02-06T15:16:16.240612+00:00", "id": "47535", "progress": {"completed": 1, "total_count": 1}, "resource_uri": "https://www.cradlepointecm.com/api/v2/speed_test/47535/", "results": [{"created_at": "2019-02-06 15:16:16.260749+00:00", "net_device_id": 12345678, "results": "TCP Download Test Timestamp: 2019-02-18 16:14:56 Duration: 10.01 Seconds Client Received: 69.6 MB Client Sent: 0 bytesServer Received: 0 bytes Server Sent: 70.4 MB Download Throughput: 58.34 Mbps", "router_id": 123456, "state": "success", "updated_at": "2019-02-06 15:16:19.573507+00:00"}], "state": "complete", "updated_at": "2019-02-06T15:17:16.362784+00:00"}}}}}, "tags": ["speed test"]}, "delete": {"operationId": "speed_test__speed_test_delete_speed_test_id", "summary": "Deletes a speed test job.", "description": "Deletes a speed test job.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "path", "description": "ID of the speed test", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "No response was specified"}}, "tags": ["speed test"]}}, "/speed_test/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "post": {"operationId": "speed_test__speed_test_post_speed_test", "summary": "Creates a new speed test job", "description": "Used to create and queue a speed test job. Once started the speed test job will queue as many individual speed tests as the system allows. When a speed test finishes more speed tests are started. This repeats until all the speed tests have completed.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Add the JSON that defines the speed test", "required": true}, "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"account": "https://www.cradlepointecm.com/api/v2/accounts/1/", "config": {"host": "YOURTESTSERVER.COM", "max_test_concurrency": 5, "net_device_ids": [12345678], "port": 12865, "size": null, "test_timeout": 10, "test_type": "TCP Download", "time": 10}, "created_at": "2019-02-06T15:16:16.240612+00:00", "id": "47535", "progress": null, "resource_uri": "https://www.cradlepointecm.com/api/v2/speed_test/47535/", "results": null, "state": "created", "updated_at": "2019-02-06T15:16:16.240636+00:00"}}}}}, "tags": ["speed test"]}}, "/api/v3/starlink_diagnostics": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__listStarlinkDiagnostics", "description": "Returns a list of starlink diagnostics", "summary": "List Starlink Diagnostics", "parameters": [{"name": "filter[connection_state]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"in": "query", "name": "filter[dish_obstructed]", "schema": {"type": "boolean"}}, {"name": "filter[starlink_interface]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "sort", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": {"type": "array", "items": {"type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at", "connection_state", "-connection_state"]}}, "explode": false}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_PaginatedStarlinkDiagnosticsV3List"}}}, "description": ""}, "400": {"description": "Bad request"}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_diagnostics/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__retrieveStarlinkDiagnostic", "description": "Retrieves a single starlink diagnostic", "summary": "Retrieve a single starlink diagnostic", "parameters": [{"in": "path", "name": "id", "schema": {"type": "string"}, "required": true}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkDiagnosticsV3Response"}}}, "description": ""}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_interfaces": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__listStarlinkInterfaces", "description": "Returns a list of starlink interfaces", "summary": "List Starlink Interfaces", "parameters": [{"name": "filter[carrier]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[gateway_ip]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[net_device]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[port]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[software_version]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "filter[terminal_identifier]", "required": false, "in": "query", "description": "", "schema": {"type": "string"}}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "sort", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": {"type": "array", "items": {"type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"]}}, "explode": false}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_PaginatedStarlinkInterfacesV3List"}}}, "description": ""}, "400": {"description": "Bad request"}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_interfaces/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__retrieveStarlinkInterface", "description": "Retrieves a single starlink interface", "summary": "Retrieve a single starlink interface", "parameters": [{"in": "path", "name": "id", "schema": {"type": "string"}, "required": true}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfacesV3Response"}}}, "description": ""}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_interfaces/reboots": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__listStarlinkInterfaceReboots", "description": "Return starlink interface reboot jobs.", "summary": "List starlink interface reboot jobs", "parameters": [{"in": "query", "name": "filter[starlink_interface]", "schema": {"type": "integer"}, "description": "Filter by starlink interface ID"}, {"in": "query", "name": "filter[state]", "schema": {"type": "string", "enum": ["created", "failed", "pending", "running", "success", "syncing"]}, "description": "Filter by job state (created, pending, running, syncing, success, failed)"}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "sort", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": {"type": "array", "items": {"type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"]}}, "explode": false}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_PaginatedStarlinkInterfaceRebootList"}}}, "description": ""}, "400": {"description": "Bad request"}, "403": {"description": "Request forbidden"}}}, "post": {"operationId": "starlink_interfaces__createStarlinkInterfaceReboot", "description": "Create a starlink interface reboot job.", "summary": "Reboot a starlink interface", "tags": ["starlink interfaces"], "requestBody": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfaceRebootCreateRequest"}}}, "required": true}, "security": [{"tokenAuth": []}], "responses": {"201": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfaceRebootResponse"}}}, "description": "Reboot job created. Location header contains the URL of the new resource.", "headers": {"Location": {"description": "URL of the newly created resource", "schema": {"type": "string", "format": "uri"}}}}, "400": {"description": "Bad request"}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_interfaces/reboots/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__retrieveStarlinkInterfaceReboot", "description": "Retrieve a single starlink interface reboot job.", "summary": "Retrieve a starlink interface reboot job", "parameters": [{"in": "path", "name": "id", "schema": {"type": "string"}, "required": true}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfaceRebootResponse"}}}, "description": ""}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_interfaces/stows": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__listStarlinkInterfaceStows", "description": "Return starlink interface stow jobs.", "summary": "List starlink interface stow jobs", "parameters": [{"in": "query", "name": "filter[starlink_interface]", "schema": {"type": "integer"}, "description": "Filter by starlink interface ID"}, {"in": "query", "name": "filter[state]", "schema": {"type": "string", "enum": ["created", "failed", "pending", "running", "success", "syncing"]}, "description": "Filter by job state (created, pending, running, syncing, success, failed)"}, {"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "sort", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": {"type": "array", "items": {"type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"]}}, "explode": false}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_PaginatedStarlinkInterfaceStowList"}}}, "description": ""}, "400": {"description": "Bad request"}, "403": {"description": "Request forbidden"}}}, "post": {"operationId": "starlink_interfaces__createStarlinkInterfaceStow", "description": "Create a starlink interface stow/unstow job.", "summary": "Stow or unstow a starlink interface", "tags": ["starlink interfaces"], "requestBody": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfaceStowCreateRequest"}}}, "required": true}, "security": [{"tokenAuth": []}], "responses": {"201": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfaceStowResponse"}}}, "description": "Stow job created. Location header contains the URL of the new resource.", "headers": {"Location": {"description": "URL of the newly created resource", "schema": {"type": "string", "format": "uri"}}}}, "400": {"description": "Bad request"}, "403": {"description": "Request forbidden"}}}}, "/api/v3/starlink_interfaces/stows/{id}": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "starlink_interfaces__retrieveStarlinkInterfaceStow", "description": "Retrieve a single starlink interface stow job.", "summary": "Retrieve a starlink interface stow job", "parameters": [{"in": "path", "name": "id", "schema": {"type": "string"}, "required": true}], "tags": ["starlink interfaces"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/starlink_interfaces_StarlinkInterfaceStowResponse"}}}, "description": ""}, "403": {"description": "Request forbidden"}}}}, "/api/v3/subscriptions": {"servers": [{"url": "https://api.cradlepointecm.com", "description": "Generated server url"}], "get": {"tags": ["subscriptions"], "summary": "Get a response using given parameters", "operationId": "subscriptions__api_v3_subscriptions_list", "parameters": [{"name": "page[after]", "in": "query", "description": "Page after (next page)", "schema": {"type": "string"}}, {"name": "page[before]", "in": "query", "description": "Page before (prior page)", "schema": {"type": "string"}}, {"name": "page[size]", "in": "query", "description": "Page size (default size: 20, Max Page Size: 50)", "schema": {"type": "integer"}}, {"name": "filter[start_time]", "in": "query", "description": "filter by start_time", "schema": {"type": "string", "format": "date-time", "example": "1970-01-01T00:00:00Z"}}, {"name": "filter[end_time]", "in": "query", "description": "filter by end_time", "schema": {"type": "string", "format": "date-time", "example": "1970-01-01T00:00:00Z"}}], "responses": {"200": {"description": "Success! You should have a page! If it doesn't contain anything, your query filtered everything out", "content": {"application/vnd.api+json": {"schema": {"$ref": "#/components/schemas/subscriptions_SimpleJsonApiEnvelopeListSubscriptions"}}}}}, "security": [{"tokenAuth": []}]}}, "/api/v3/beta/tenant_authorizations": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "tenant_authorizations__tenant_authorizations_list", "description": "Return a list of tenant authorizations", "parameters": [{"name": "page[after]", "required": false, "in": "query", "description": "Cursor for next page.", "schema": {"type": "string"}}, {"name": "page[before]", "required": false, "in": "query", "description": "Cursor for prior page.", "schema": {"type": "string"}}, {"name": "page[size]", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": {"type": "integer"}}, {"name": "search", "required": false, "in": "query", "description": "The search query param performs a case insensitive substring search on a set of fields.This operation creates a new Test Alert Push Destination.
", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}}, "description": "Json object", "required": true}, "responses": {"200": {"description": "No response was specified"}}, "tags": ["test alert push destination"]}}, "/api/v3/unmasked_wifi_passwords": {"servers": [{"url": "https://api.cradlepointecm.com"}], "get": {"operationId": "unmasked_wifi_passwords__external_v3_unmasked_wifi_passwords_list", "description": "Returns a list of unmasked Wi-Fi passwords", "summary": "Display unmasked Wi-Fi passwords.", "parameters": [{"in": "query", "name": "router", "schema": {"type": "string"}, "description": "List of ID\u2019s to extract the Wi-Fi passwords from.", "required": true}], "tags": ["unmasked wifi passwords"], "security": [{"tokenAuth": []}], "responses": {"200": {"content": {"application/vnd.api+json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/unmasked_wifi_passwords_UnmaskedWifiPasswordsV3"}}}, "application/json": {"example": {"data": [{"id": "y2wV9WVQtRbMCs5", "type": "unmasked_wifi_passwords", "attributes": {"router_id": "11", "router_name": "RouterA", "wifi_networks": [{"network_id": "ABCD123", "network_name": "WiFiA", "password": "password1"}]}}, {"id": "IhuwrO3BBOQvyjJ", "type": "unmasked_wifi_passwords", "attributes": {"router_id": "22", "router_name": "RouterB", "wifi_networks": [{"network_id": "EFGH456", "network_name": "WiFiB", "password": "password2"}, {"network_id": "IJKL789", "network_name": "WiFiC", "password": "password3"}]}}]}}}, "description": "Successful call "}, "403": {"description": "Request forbidden"}}}}, "/users/": {"servers": [{"url": "https://www.cradlepointecm.com/api/v2"}], "get": {"operationId": "users__users", "summary": "Get information about users", "description": "Use the GET method on this endpoint to retrieve users records. Use the available filtering fields to narrow or broaden your search.", "parameters": [{"in": "header", "description": "ECM API app Id", "name": "X-ECM-API-ID", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "ECM API app key", "name": "X-ECM-API-KEY", "required": true, "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API app Id", "name": "X-CP-API-ID", "required": true, "x-data-threescale-name": "app_ids", "schema": {"type": "string"}}, {"in": "header", "description": "Cradlepoint API access key", "name": "X-CP-API-KEY", "required": true, "x-data-threescale-name": "app_keys", "schema": {"type": "string"}}, {"in": "query", "description": "User ID", "name": "id", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Username of a user", "name": "username", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "A user's email address", "name": "email", "required": false, "schema": {"type": "string"}}, {"in": "query", "description": "Restricts the number of records returned in a recordset to this value. Max value is 500.", "name": "limit", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"in": "query", "description": "Specifies where (an index) in a recordset to begin returning records.", "name": "offset", "required": false, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Example response.", "content": {"application/json": {"example": {"data": [{"account": "https://www.cradlepointecm.com/api/v2/accounts/