{
  "opencollection": "1.0.0",
  "info": {
    "name": "Soracom and Query Analysis Group API",
    "version": "20250903-043502"
  },
  "items": [
    {
      "info": {
        "name": "Group",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Groups.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/groups",
            "params": [
              {
                "name": "tag_name",
                "value": "",
                "type": "query",
                "description": "Tag name of the group. Filters through all groups that exactly match the tag name. When tag_name is specified, tag_value is required."
              },
              {
                "name": "tag_value",
                "value": "",
                "type": "query",
                "description": "Tag value of the groups."
              },
              {
                "name": "tag_value_match_mode",
                "value": "",
                "type": "query",
                "description": "Search criteria for tag strings (`tag_value`)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results per response page."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The last Group ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next group onward."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of Groups."
        },
        {
          "info": {
            "name": "Create Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/groups",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Create a new group."
        },
        {
          "info": {
            "name": "Get Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/groups/:group_id",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns the group specified by the group ID."
        },
        {
          "info": {
            "name": "Delete Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/groups/:group_id",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes the group specified by Group ID."
        },
        {
          "info": {
            "name": "Update group configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/groups/:group_id/configuration/:namespace",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target group. The group ID can be obtained via the [Group:listGroups API](#!/Group/listGroups)."
              },
              {
                "name": "namespace",
                "value": "",
                "type": "path",
                "description": "A string indicating the configuration target. It varies depending on the configuration content.\n\n- `SoracomAir`: Custom DNS, Metadata service, VPG (Virtual Private Gateway), CHAP authentication, Simple Location function, Binary Parser.\n- `SoracomBeam`: SORACOM Beam.\n- `SoracomEndorse`: SORACOM Endorse.\n- `SoracomFunk`: SORACOM Funk.\n- `SoracomFunnel`: SORACOM Funnel.\n- `SoracomHarvest`: SORACOM Harvest Data.\n- `SoracomHarvestFiles`: SORACOM Harvest Files.\n- `SoracomKrypton`: SORACOM Krypton.\n- `SoracomOrbit`: SORACOM Orbit.\n- `UnifiedEndpoint`: Unified Endpoint.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Updates the configuration of the specified group."
        },
        {
          "info": {
            "name": "Delete Group Configuration Namespace",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/groups/:group_id/configuration/:namespace",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              },
              {
                "name": "namespace",
                "value": "",
                "type": "path",
                "description": "Namespace to be deleted."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a namespace for the specified group."
        },
        {
          "info": {
            "name": "Delete Group Configuration Parameters",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/groups/:group_id/configuration/:namespace/:name",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              },
              {
                "name": "namespace",
                "value": "",
                "type": "path",
                "description": "Namespace of target parameters."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Parameter name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete parameters for the specified group."
        },
        {
          "info": {
            "name": "List Subscribers in a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/groups/:group_id/subscribers",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results per response page."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of subscribers that belong to the specified group by group ID."
        },
        {
          "info": {
            "name": "Update Group Tags",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/groups/:group_id/tags",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Adds/updates tags of specified configuration group."
        },
        {
          "info": {
            "name": "Delete Group Tag",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/groups/:group_id/tags/:tag_name",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "ID of the target Group."
              },
              {
                "name": "tag_name",
                "value": "",
                "type": "path",
                "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes tag from the specified group."
        }
      ]
    }
  ],
  "bundled": true
}