{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List Snapshots API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Snapshots",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a Database Instance snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/snapshots",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "instance_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Database Instance."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a new snapshot of a Database Instance. You must define the `name` parameter in the request."
        },
        {
          "info": {
            "name": "List snapshots",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of the snapshot."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Criteria to use when ordering snapshot listing."
              },
              {
                "name": "instance_id",
                "value": "",
                "type": "query",
                "description": "UUID of the Database Instance."
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "Organization ID the snapshots belongs to."
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Project ID the snapshots belongs to."
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field."
        },
        {
          "info": {
            "name": "Get a Database Instance snapshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "UUID of the snapshot."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve information about a given snapshot, specified by its `snapshot_id` and `region`. Full details about the snapshot, like size and expiration date, are returned in the response."
        },
        {
          "info": {
            "name": "Update a Database Instance snapshot",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "UUID of the snapshot to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters."
        },
        {
          "info": {
            "name": "Delete a Database Instance snapshot",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "UUID of the snapshot to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete a given snapshot of a Database Instance. You must specify, in the endpoint,  the `region` and `snapshot_id` parameters of the snapshot you want to delete."
        },
        {
          "info": {
            "name": "Create a new Database Instance from a snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id/create-instance",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "Block snapshot of the Database Instance."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory."
        },
        {
          "info": {
            "name": "List snapshots",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "organization",
                "value": "",
                "type": "query",
                "description": "List snapshots only for this Organization ID."
              },
              {
                "name": "project",
                "value": "",
                "type": "query",
                "description": "List snapshots only for this Project ID."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of snapshots returned per page (positive integer lower or equal to 100)."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to be returned."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "List snapshots of the requested name."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "List snapshots that have the requested tag."
              },
              {
                "name": "base_volume_id",
                "value": "",
                "type": "query",
                "description": "List snapshots originating only from this volume."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List all snapshots of an Organization in a specified Availability Zone."
        },
        {
          "info": {
            "name": "Create a snapshot from a specified volume or from a QCOW2 file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots",
            "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 snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone."
        },
        {
          "info": {
            "name": "Get a snapshot",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots/:snapshot_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "UUID of the snapshot you want to get."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Get details of a snapshot with the specified ID."
        },
        {
          "info": {
            "name": "Set snapshot",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots/:snapshot_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Replace all the properties of a snapshot."
        },
        {
          "info": {
            "name": "Update a snapshot",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots/:snapshot_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "UUID of the snapshot. (UUID format)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update the properties of a snapshot."
        },
        {
          "info": {
            "name": "Delete a snapshot",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots/:snapshot_id",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "UUID of the snapshot you want to delete."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete the snapshot with the specified ID."
        },
        {
          "info": {
            "name": "Export a snapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/instance/v1/zones/:zone/snapshots/:snapshot_id/export",
            "params": [
              {
                "name": "zone",
                "value": "",
                "type": "path",
                "description": "The zone you want to target"
              },
              {
                "name": "snapshot_id",
                "value": "",
                "type": "path",
                "description": "Snapshot ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Export a snapshot to a specified Object Storage bucket in the same region."
        }
      ]
    }
  ],
  "bundled": true
}