{
  "opencollection": "1.0.0",
  "info": {
    "name": "Macrometa API Reference Activity Metrics API key API",
    "version": "0.17.17"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "API key",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get API keys details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/api/vwr/v1/apikey",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The _limit_ parameter determines the number of API keys returned."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Represents the starting point from where to begin fetching the API key records. This parameter is especially useful in conjunction with the _limit_ parameter for pagination of a large number of API key records. By default, it is set to 0, meaning that data retrieval will start from the very first record. For example, if you have 10,000 API key records and set the _limit_ to 100, then the first API call without an offset will retrieve records 1 to 100. If you set the _offset_ to 100 for the next call, you will retrieve records 101 to 200, and so on. This way, by incrementing the _offset_ by the _limit_ value for successive calls, you can paginate through the entire dataset."
              },
              {
                "name": "pattern",
                "value": "",
                "type": "query",
                "description": "Fetch API key information that matches the pattern. For example, a pattern could be 'aa' or 'test'. To get all API keys, set the pattern to '*'."
              },
              {
                "name": "sortby",
                "value": "",
                "type": "query",
                "description": "The field used for sorting."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sort order:\n * _asc_ - Ascending, from A to Z\n * _desc_ - Descending, from Z to A\n"
              }
            ]
          },
          "docs": "Gets all API key details."
        },
        {
          "info": {
            "name": "Create a new API Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-play.paas.macrometa.io/api/vwr/v1/apikey",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new API key. Keep the API key safe, because it cannot be retrieved. Provide the TTL in days and specify the role of the API key.\n\n__The following roles are supported.__\n* admin - Can run all API endpoints.\n* editor - Can run all API endpoints, except API keys endpoints.\n* viewer - Can only run read API endpoints.\n\nThis API requires _admin_ permissions to run.\n"
        },
        {
          "info": {
            "name": "Get API key by unique key_id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/api/vwr/v1/apikey/:key_id",
            "params": [
              {
                "name": "key_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the API key."
              }
            ]
          },
          "docs": "Gets API key by unique key_id."
        },
        {
          "info": {
            "name": "Update API key",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-play.paas.macrometa.io/api/vwr/v1/apikey/:key_id",
            "params": [
              {
                "name": "key_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the API key."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the activation status of the API key.\n\nThis API requires _admin_ permissions to run.\n"
        },
        {
          "info": {
            "name": "Delete key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-play.paas.macrometa.io/api/vwr/v1/apikey/:key_id",
            "params": [
              {
                "name": "key_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the API key."
              }
            ]
          },
          "docs": "Delete API key with a unique _key_id_.\n\nThis API requires _admin_ permissions to run.\n"
        }
      ]
    }
  ],
  "bundled": true
}