{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List Volumes API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Volumes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/block-migration/apply",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "To be used, the call to this endpoint must be preceded by a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided."
        },
        {
          "info": {
            "name": "Get a volume or snapshot's migration plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/block-migration/plan",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint afterward.\nThe endpoint returns the resources that should be migrated together:\n- the volume and any snapshots created from the volume, if the call was made to plan a volume migration.\n- the base volume of the snapshot (if th"
        },
        {
          "info": {
            "name": "List volumes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/volumes",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "volume_type",
                "value": "",
                "type": "query",
                "description": "Filter by volume type."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "A positive integer lower or equal to 100 to select the number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A positive integer to choose the page to return."
              },
              {
                "name": "organization",
                "value": "",
                "type": "query",
                "description": "Filter volume by Organization ID."
              },
              {
                "name": "project",
                "value": "",
                "type": "query",
                "description": "Filter volume by Project ID."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "Filter volumes with these exact tags (to filter with several tags, use commas to separate them)."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter volume by name (for eg. \"vol\" will return \"myvolume\" but not \"data\")."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List volumes in the specified Availability Zone. You can filter the output by volume type."
        },
        {
          "info": {
            "name": "Create a volume",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/volumes",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a volume of a specified type in an Availability Zone."
        },
        {
          "info": {
            "name": "Update volume",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/volumes/:id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique ID of the volume."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Replace all volume properties with a volume message."
        },
        {
          "info": {
            "name": "Get a volume",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/volumes/:volume_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "volume_id",
                "value": "",
                "type": "path",
                "description": "UUID of the volume you want to get."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Get details of a volume with the specified ID."
        },
        {
          "info": {
            "name": "Update a volume",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/volumes/:volume_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "volume_id",
                "value": "",
                "type": "path",
                "description": "UUID of the volume."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Replace the name and/or size properties of a volume specified by its ID, with the specified value(s)."
        },
        {
          "info": {
            "name": "Delete a volume",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/volumes/:volume_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "volume_id",
                "value": "",
                "type": "path",
                "description": "UUID of the volume you want to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete the volume with the specified ID."
        }
      ]
    }
  ],
  "bundled": true
}