{
  "opencollection": "1.0.0",
  "info": {
    "name": "Soracom and Query Analysis Lagoon API",
    "version": "20250903-043502"
  },
  "items": [
    {
      "info": {
        "name": "Lagoon",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a custom icon image link of Soracom Lagoon Console",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/lagoon/image/link",
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get a custom icon image link of Soracom Lagoon Console."
        },
        {
          "info": {
            "name": "Get the status of active Soracom Lagoon license packs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/lagoon/license_packs",
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Get the status of active Soracom Lagoon license packs."
        },
        {
          "info": {
            "name": "Update the quantities for license packs of Soracom Lagoon",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/lagoon/license_packs",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update the quantities for license packs of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The quantities for license packs of Soracom Lagoon cannot be updated with SAM user credentials.\n"
        },
        {
          "info": {
            "name": "Update the plan of Soracom Lagoon",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/lagoon/plan",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update the plan of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The plan of Lagoon cannot be updated with SAM user credentials.\n"
        },
        {
          "info": {
            "name": "Register (activate) Soracom Lagoon",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/lagoon/register",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Register (activate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be registered with SAM user credentials.\n"
        },
        {
          "info": {
            "name": "Terminate (deactivate) Soracom Lagoon",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/lagoon/terminate",
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Terminate (deactivate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be terminated with SAM user credentials.\n"
        },
        {
          "info": {
            "name": "List Soracom Lagoon users that belong to operator",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/lagoon/users",
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "List Soracom Lagoon users that belong to operator."
        },
        {
          "info": {
            "name": "Create a Soracom Lagoon user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/lagoon/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Create a Soracom Lagoon user."
        },
        {
          "info": {
            "name": "Delete a Soracom Lagoon user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id",
            "params": [
              {
                "name": "lagoon_user_id",
                "value": "",
                "type": "path",
                "description": "Target ID of the lagoon user."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a Soracom Lagoon user."
        },
        {
          "info": {
            "name": "Update email address of a Soracom Lagoon user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id/email",
            "params": [
              {
                "name": "lagoon_user_id",
                "value": "",
                "type": "path",
                "description": "Target ID of the lagoon user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update email address of a Soracom Lagoon user."
        },
        {
          "info": {
            "name": "Update password of a Soracom Lagoon user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id/password",
            "params": [
              {
                "name": "lagoon_user_id",
                "value": "",
                "type": "path",
                "description": "Target ID of the lagoon user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update password of a Soracom Lagoon user."
        },
        {
          "info": {
            "name": "Update permission of a Soracom Lagoon user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id/permission",
            "params": [
              {
                "name": "lagoon_user_id",
                "value": "",
                "type": "path",
                "description": "Target ID of the lagoon user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update permission of a Soracom Lagoon user."
        }
      ]
    }
  ],
  "bundled": true
}