{ "opencollection": "1.0.0", "info": { "name": "Instance 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." } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "CheckBlockMigrationOrganizationQuotas", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/block-migration/check-organization-quotas", "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" } } }, { "info": { "name": "GetDashboard", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/dashboard", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "organization", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } } } ] }, { "info": { "name": "Images", "type": "folder" }, "items": [ { "info": { "name": "List Instance images", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/images", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "organization", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "public", "value": "", "type": "query" }, { "name": "arch", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query" }, { "name": "tags", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all existing Instance images." }, { "info": { "name": "Create an Instance image", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/images", "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 an Instance image from the specified snapshot ID." }, { "info": { "name": "Update image", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/images/:id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replace all image properties with an image message." }, { "info": { "name": "Get an Instance image", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/images/:image_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "image_id", "value": "", "type": "path", "description": "UUID of the image you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get details of an image with the specified ID." }, { "info": { "name": "Update image", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/images/:image_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "image_id", "value": "", "type": "path", "description": "UUID of the image. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the properties of an image." }, { "info": { "name": "Delete an Instance image", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/images/:image_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "image_id", "value": "", "type": "path", "description": "UUID of the image you want to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete the image with the specified ID." } ] }, { "info": { "name": "IPs", "type": "folder" }, "items": [ { "info": { "name": "List all flexible IPs", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/ips", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "project", "value": "", "type": "query", "description": "Project ID in which the IPs are reserved." }, { "name": "organization", "value": "", "type": "query", "description": "Organization ID in which the IPs are reserved." }, { "name": "tags", "value": "", "type": "query", "description": "Filter IPs with these exact tags (to filter with several tags, use commas to separate them)." }, { "name": "name", "value": "", "type": "query", "description": "Filter on the IP address (Works as a LIKE operation on the IP address)." }, { "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": "type", "value": "", "type": "query", "description": "Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6')." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all flexible IPs in a specified zone." }, { "info": { "name": "Reserve a flexible IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/ips", "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": "Reserve a flexible IP and attach it to the specified Instance." }, { "info": { "name": "Releases the reserved IP without deleting the reservation.", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/ips/:ip_id/release-to-ipam", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip_id", "value": "", "type": "path", "description": "ID of the IP you want to release from the Instance but retain in IPAM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "**The IP remains available in IPAM**, which means that it is still reserved by the Organization, and can be reattached to another resource (Instance or other product)." }, { "info": { "name": "Get a flexible IP", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/ips/:ip", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip", "value": "", "type": "path", "description": "IP ID or address to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get details of an IP with the specified ID or address." }, { "info": { "name": "Update a flexible IP", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/ips/:ip", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip", "value": "", "type": "path", "description": "IP ID or IP address." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update a flexible IP in the specified zone with the specified ID." }, { "info": { "name": "Delete a flexible IP", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/ips/:ip", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip", "value": "", "type": "path", "description": "ID or address of the IP to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete the IP with the specified ID." } ] }, { "info": { "name": "Placement Groups", "type": "folder" }, "items": [ { "info": { "name": "List placement groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "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": "List only placement groups of this Organization ID." }, { "name": "project", "value": "", "type": "query", "description": "List only placement groups of this Project ID." }, { "name": "tags", "value": "", "type": "query", "description": "List placement groups with these exact tags (to filter with several tags, use commas to separate them)." }, { "name": "name", "value": "", "type": "query", "description": "Filter placement groups by name (for eg. \"cluster1\" will return \"cluster100\" and \"cluster1\" but not \"foo\")." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all placement groups in a specified Availability Zone." }, { "info": { "name": "Create a placement group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups", "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 new placement group in a specified Availability Zone." }, { "info": { "name": "Get a placement group", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path", "description": "UUID of the placement group you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the specified placement group." }, { "info": { "name": "Set placement group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Set all parameters of the specified placement group." }, { "info": { "name": "Update a placement group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path", "description": "UUID of the placement group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update one or more parameter of the specified placement group." }, { "info": { "name": "Delete the specified placement group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path", "description": "UUID of the placement group you want to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete the specified placement group" }, { "info": { "name": "Get placement group servers", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path", "description": "UUID of the placement group you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get all Instances belonging to the specified placement group." }, { "info": { "name": "Set placement group servers", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path", "description": "UUID of the placement group you want to set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Set all Instances belonging to the specified placement group." }, { "info": { "name": "Update placement group servers", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/placement_groups/:placement_group_id/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "placement_group_id", "value": "", "type": "path", "description": "UUID of the placement group you want to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update all Instances belonging to the specified placement group." } ] }, { "info": { "name": "Instance Types", "type": "folder" }, "items": [ { "info": { "name": "List Instance types", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/products/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List available Instance types and their technical details." }, { "info": { "name": "Get availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/products/servers/availability", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "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." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get availability for all Instance types." } ] }, { "info": { "name": "Volume Types", "type": "folder" }, "items": [ { "info": { "name": "List volume types", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/products/volumes", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all volume types and their technical details." } ] }, { "info": { "name": "Security Groups", "type": "folder" }, "items": [ { "info": { "name": "List security groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "name", "value": "", "type": "query", "description": "Name of the security group." }, { "name": "organization", "value": "", "type": "query", "description": "Security group Organization ID." }, { "name": "project", "value": "", "type": "query", "description": "Security group Project ID." }, { "name": "tags", "value": "", "type": "query", "description": "List security groups with these exact tags (to filter with several tags, use commas to separate them)." }, { "name": "project_default", "value": "", "type": "query", "description": "Filter security groups with this value for project_default." }, { "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." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all existing security groups." }, { "info": { "name": "Create a security group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups", "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 security group with a specified name and description." }, { "info": { "name": "Update a security group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "id", "value": "", "type": "path", "description": "UUID of the security group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replace all security group properties with a security group message." }, { "info": { "name": "Get a security group", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the details of a security group with the specified ID." }, { "info": { "name": "Update a security group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the properties of security group." }, { "info": { "name": "Delete a security group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group you want to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a security group with the specified ID." }, { "info": { "name": "List rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group." }, { "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." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the rules of the a specified security group ID." }, { "info": { "name": "Create rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a rule in the specified security group ID." }, { "info": { "name": "Update all the rules of a security group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group to update the rules on." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request." }, { "info": { "name": "Get rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path" }, { "name": "security_group_rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get details of a security group rule with the specified ID." }, { "info": { "name": "Set security group rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path" }, { "name": "security_group_rule_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 rule from a specified security group." }, { "info": { "name": "Update security group rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group. (UUID format)" }, { "name": "security_group_rule_id", "value": "", "type": "path", "description": "UUID of the rule. (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 rule from a specified security group." }, { "info": { "name": "Delete rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path" }, { "name": "security_group_rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a security group rule with the specified ID." }, { "info": { "name": "Get default rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/default/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Lists the default rules applied to all the security groups." } ] }, { "info": { "name": "Instances", "type": "folder" }, "items": [ { "info": { "name": "List all Instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "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": "List only Instances of this Organization ID." }, { "name": "project", "value": "", "type": "query", "description": "List only Instances of this Project ID." }, { "name": "name", "value": "", "type": "query", "description": "Filter Instances by name (eg. \"server1\" will return \"server100\" and \"server1\" but not \"foo\")." }, { "name": "private_ip", "value": "", "type": "query", "description": "List Instances by private_ip. (IP address)" }, { "name": "without_ip", "value": "", "type": "query", "description": "List Instances that are not attached to a public IP." }, { "name": "with_ip", "value": "", "type": "query", "description": "List Instances by IP (both private_ip and public_ip are supported). (IP address)" }, { "name": "commercial_type", "value": "", "type": "query", "description": "List Instances of this commercial type." }, { "name": "state", "value": "", "type": "query", "description": "List Instances in this state." }, { "name": "tags", "value": "", "type": "query", "description": "List Instances with these exact tags (to filter with several tags, use commas to separate them)." }, { "name": "private_network", "value": "", "type": "query", "description": "List Instances in this Private Network." }, { "name": "order", "value": "", "type": "query", "description": "Define the order of the returned servers." }, { "name": "private_networks", "value": "", "type": "query", "description": "List Instances from the given Private Networks (use commas to separate them)." }, { "name": "private_nic_mac_address", "value": "", "type": "query", "description": "List Instances associated with the given private NIC MAC address." }, { "name": "servers", "value": "", "type": "query", "description": "List Instances from these server ids (use commas to separate them)." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all Instances in a specified Availability Zone, e.g. `fr-par-1`." }, { "info": { "name": "Create an Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers", "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 new Instance of the specified commercial type in the specified zone. Pay attention to the volumes parameter, which takes an object which can be used in different ways to achieve different behaviors.\nGet more information in the [Technical Information](#technical-information) section of the introduction." }, { "info": { "name": "Get an Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the details of a specified Instance." }, { "info": { "name": "Update an Instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the Instance information, such as name, boot mode, or tags." }, { "info": { "name": "Delete an Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete the Instance with the specified ID." }, { "info": { "name": "List Instance actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/action", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance." }, { "info": { "name": "Perform action", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/action", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Perform an action on an Instance.\nAvailable actions are:\n* `poweron`: Start a stopped Instance.\n* `poweroff`: Fully stop the Instance and release the hypervisor slot.\n* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.\n* `reboot`: Stop the instance and restart it.\n* `backup`: Create an image with all the volumes of an Instance.\n* `terminate`: Delete the Instance along with its attached local volumes.\n* `enable_routed_ip`: Migrate the Instance to the new network stack.\n\nTh" }, { "info": { "name": "Attach a filesystem volume to an Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/attach-filesystem", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Attach a filesystem volume to an Instance" }, { "info": { "name": "Attach a volume to an Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/attach-volume", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Attach a volume to an Instance" }, { "info": { "name": "Get Instance compatible types", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/compatible-types", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get compatible commercial types that can be used to update the Instance. The compatibility of an Instance offer is based on:\n* the CPU architecture\n* the OS type\n* the required l_ssd storage size\n* the required scratch storage size\nIf the specified Instance offer is flagged as end of service, the best compatible offer is the first returned." }, { "info": { "name": "Detach a filesystem volume from an Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/detach-filesystem", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Detach a filesystem volume from an Instance" }, { "info": { "name": "Detach a volume from an Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/detach-volume", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Detach a volume from an Instance" } ] }, { "info": { "name": "Private NICs", "type": "folder" }, "items": [ { "info": { "name": "List all private NICs", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/private_nics", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "Instance to which the private NIC is attached." }, { "name": "tags", "value": "", "type": "query", "description": "Private NIC tags." }, { "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." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all private NICs of a specified Instance." }, { "info": { "name": "Create a private NIC connecting an Instance to a Private Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/private_nics", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance the private NIC will be attached to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a private NIC connecting an Instance to a Private Network" }, { "info": { "name": "Get a private NIC", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/private_nics/:private_nic_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "Instance to which the private NIC is attached." }, { "name": "private_nic_id", "value": "", "type": "path", "description": "Private NIC unique ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get private NIC properties." }, { "info": { "name": "Update a private NIC", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/private_nics/:private_nic_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance the private NIC will be attached to." }, { "name": "private_nic_id", "value": "", "type": "path", "description": "Private NIC unique ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update one or more parameter(s) of a specified private NIC." }, { "info": { "name": "Delete a private NIC", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/private_nics/:private_nic_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "Instance to which the private NIC is attached." }, { "name": "private_nic_id", "value": "", "type": "path", "description": "Private NIC unique ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a private NIC" } ] }, { "info": { "name": "User Data", "type": "folder" }, "items": [ { "info": { "name": "List user data", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/user_data", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all user data keys registered on a specified Instance." }, { "info": { "name": "Get user data", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/user_data/:key", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance." }, { "name": "key", "value": "", "type": "path", "description": "Key of the user data to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the content of a user data with the specified key on an Instance." }, { "info": { "name": "Add/set user data", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/user_data/:key", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance." }, { "name": "key", "value": "", "type": "path", "description": "Key of the user data to set." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add or update a user data with the specified key on an Instance." }, { "info": { "name": "Delete user data", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/servers/:server_id/user_data/:key", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "server_id", "value": "", "type": "path", "description": "UUID of the Instance." }, { "name": "key", "value": "", "type": "path", "description": "Key of the user data to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete the specified key from an Instance's user data." } ] }, { "info": { "name": "Snapshots", "type": "folder" }, "items": [ { "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 }