{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List API Keys API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "API Keys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List API keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/iam/v1alpha1/api-keys",
            "params": [
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Criteria for sorting results."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Value must be greater or equal to 1."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Value must be between 1 and 100."
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "ID of Organization."
              },
              {
                "name": "editable",
                "value": "",
                "type": "query",
                "description": "Defines whether to filter out editable API keys or not."
              },
              {
                "name": "expired",
                "value": "",
                "type": "query",
                "description": "Defines whether to filter out expired API keys or not."
              },
              {
                "name": "access_key",
                "value": "",
                "type": "query",
                "description": "Filter by access key (deprecated in favor of `access_keys`)."
              },
              {
                "name": "description",
                "value": "",
                "type": "query",
                "description": "Filter by description."
              },
              {
                "name": "bearer_id",
                "value": "",
                "type": "query",
                "description": "Filter by bearer ID."
              },
              {
                "name": "bearer_type",
                "value": "",
                "type": "query",
                "description": "Filter by type of bearer."
              },
              {
                "name": "access_keys",
                "value": "",
                "type": "query",
                "description": "Filter by a list of access keys."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`."
        },
        {
          "info": {
            "name": "Create an API key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/iam/v1alpha1/api-keys",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id`, which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that the secret key is only shown once. Make sure that you copy and store both keys somewhere safe."
        },
        {
          "info": {
            "name": "Get an API key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/iam/v1alpha1/api-keys/:access_key",
            "params": [
              {
                "name": "access_key",
                "value": "",
                "type": "path",
                "description": "Access key to search for."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation."
        },
        {
          "info": {
            "name": "Update an API key",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/iam/v1alpha1/api-keys/:access_key",
            "params": [
              {
                "name": "access_key",
                "value": "",
                "type": "path",
                "description": "Access key to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update the parameters of an API key, including `default_project_id` and `description`."
        },
        {
          "info": {
            "name": "Delete an API key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/iam/v1alpha1/api-keys/:access_key",
            "params": [
              {
                "name": "access_key",
                "value": "",
                "type": "path",
                "description": "Access key to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete."
        }
      ]
    }
  ],
  "bundled": true
}