Documentation | Instances › Check Quota For Instance Creation

API Reference

Instances

instances

Methods

Assign Security Group ->

post/v1/instances/{project_id}/{region_id}/{instance_id}/addsecuritygroup

Assign the security group to the server. To assign multiple security groups to all ports, use the NULL value for the port_id field

Attach Interface -> { tasks }

post/v1/instances/{project_id}/{region_id}/{instance_id}/attach_interface

Attach interface to instance

Change Flavor -> { tasks }

post/v1/instances/{project_id}/{region_id}/{instance_id}/changeflavor

Change the flavor of the server instance

Check Quota For Instance Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }

post/v2/instances/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified instance will be calculated

Parameters

project_id: number

region_id: number

Response fields

baremetal_basic_count_limit: number

Optional

Basic bare metal servers count limit

baremetal_basic_count_requested: number

Optional

Basic bare metal servers count requested

baremetal_basic_count_usage: number

Optional

Basic bare metal servers count usage

baremetal_gpu_count_limit: number

Optional

AI GPU bare metal servers count limit

baremetal_gpu_count_requested: number

Optional

AI GPU bare metal servers count requested

baremetal_gpu_count_usage: number

Optional

AI GPU bare metal servers count usage

baremetal_hf_count_limit: number

Optional

High-frequency bare metal servers count limit

baremetal_hf_count_requested: number

Optional

High-frequency bare metal servers count requested

baremetal_hf_count_usage: number

Optional

High-frequency bare metal servers count usage

baremetal_infrastructure_count_limit: number

Optional

Infrastructure bare metal servers count limit

baremetal_infrastructure_count_requested: number

Optional

Infrastructure bare metal servers count requested

baremetal_infrastructure_count_usage: number

Optional

Infrastructure bare metal servers count usage

baremetal_network_count_limit: number

Optional

Bare metal Network Count limit

baremetal_network_count_requested: number

Optional

Bare metal Network Count requested

baremetal_network_count_usage: number

Optional

Bare metal Network Count usage

baremetal_storage_count_limit: number

Optional

Storage bare metal servers count limit

baremetal_storage_count_requested: number

Optional

Storage bare metal servers count requested

baremetal_storage_count_usage: number

Optional

Storage bare metal servers count usage

caas_container_count_limit: number

Optional

Containers count limit

caas_container_count_requested: number

Optional

Containers count requested

caas_container_count_usage: number

Optional

Containers count usage

caas_cpu_count_limit: number

Optional

mCPU count for containers limit

caas_cpu_count_requested: number

Optional

mCPU count for containers requested

caas_cpu_count_usage: number

Optional

mCPU count for containers usage

caas_gpu_count_limit: number

Optional

Containers gpu count limit

caas_gpu_count_requested: number

Optional

Containers gpu count requested

caas_gpu_count_usage: number

Optional

Containers gpu count usage

caas_ram_size_limit: number

Optional

MB memory count for containers limit

caas_ram_size_requested: number

Optional

MB memory count for containers requested

caas_ram_size_usage: number

Optional

MB memory count for containers usage

cluster_count_limit: number

Optional

K8s clusters count limit

cluster_count_requested: number

Optional

K8s clusters count requested

cluster_count_usage: number

Optional

K8s clusters count usage

cpu_count_limit: number

Optional

vCPU Count limit

cpu_count_requested: number

Optional

vCPU Count requested

cpu_count_usage: number

Optional

vCPU Count usage

dbaas_postgres_cluster_count_limit: number

Optional

DBaaS cluster count limit

dbaas_postgres_cluster_count_requested: number

Optional

DBaaS cluster count requested

dbaas_postgres_cluster_count_usage: number

Optional

DBaaS cluster count usage

external_ip_count_limit: number

Optional

External IP Count limit

external_ip_count_requested: number

Optional

External IP Count requested

external_ip_count_usage: number

Optional

External IP Count usage

faas_cpu_count_limit: number

Optional

mCPU count for functions limit

faas_cpu_count_requested: number

Optional

mCPU count for functions requested

faas_cpu_count_usage: number

Optional

mCPU count for functions usage

faas_function_count_limit: number

Optional

Functions count limit

faas_function_count_requested: number

Optional

Functions count requested

faas_function_count_usage: number

Optional

Functions count usage

faas_namespace_count_limit: number

Optional

Functions namespace count limit

faas_namespace_count_requested: number

Optional

Functions namespace count requested

faas_namespace_count_usage: number

Optional

Functions namespace count usage

faas_ram_size_limit: number

Optional

MB memory count for functions limit

faas_ram_size_requested: number

Optional

MB memory count for functions requested

faas_ram_size_usage: number

Optional

MB memory count for functions usage

firewall_count_limit: number

Optional

Firewalls Count limit

firewall_count_requested: number

Optional

Firewalls Count requested

firewall_count_usage: number

Optional

Firewalls Count usage

floating_count_limit: number

Optional

Floating IP Count limit

floating_count_requested: number

Optional

Floating IP Count requested

floating_count_usage: number

Optional

Floating IP Count usage

gpu_count_limit: number

Optional

GPU Count limit

gpu_count_requested: number

Optional

GPU Count requested

gpu_count_usage: number

Optional

GPU Count usage

image_count_limit: number

Optional

Images Count limit

image_count_requested: number

Optional

Images Count requested

image_count_usage: number

Optional

Images Count usage

image_size_limit: number

Optional

Images Size, GiB limit

image_size_requested: number

Optional

Images Size, GiB requested

image_size_usage: number

Optional

Images Size, GiB usage

ipu_count_limit: number

Optional

IPU Count limit

ipu_count_requested: number

Optional

IPU Count requested

ipu_count_usage: number

Optional

IPU Count usage

laas_topic_count_limit: number

Optional

LaaS Topics Count limit

laas_topic_count_requested: number

Optional

LaaS Topics Count requested

laas_topic_count_usage: number

Optional

LaaS Topics Count usage

loadbalancer_count_limit: number

Optional

Load Balancers Count limit

loadbalancer_count_requested: number

Optional

Load Balancers Count requested

loadbalancer_count_usage: number

Optional

Load Balancers Count usage

network_count_limit: number

Optional

Networks Count limit

network_count_requested: number

Optional

Networks Count requested

network_count_usage: number

Optional

Networks Count usage

ram_limit: number

Optional

RAM Size, GiB limit

ram_requested: number

Optional

RAM Size, GiB requested

ram_usage: number

Optional

RAM Size, GiB usage

registry_count_limit: number

Optional

Registries count limit

registry_count_requested: number

Optional

Registries count requested

registry_count_usage: number

Optional

Registries count usage

registry_storage_limit: number

Optional

Registries volume usage, GiB limit

registry_storage_requested: number

Optional

Registries volume usage, GiB requested

registry_storage_usage: number

Optional

Registries volume usage, GiB usage

router_count_limit: number

Optional

Routers Count limit

router_count_requested: number

Optional

Routers Count requested

router_count_usage: number

Optional

Routers Count usage

secret_count_limit: number

Optional

Secret Count limit

secret_count_requested: number

Optional

Secret Count requested

secret_count_usage: number

Optional

Secret Count usage

servergroup_count_limit: number

Optional

Placement Group Count limit

servergroup_count_requested: number

Optional

Placement Group Count requested

servergroup_count_usage: number

Optional

Placement Group Count usage

sfs_count_limit: number

Optional

Shared file system Count limit

sfs_count_requested: number

Optional

Shared file system Count requested

sfs_count_usage: number

Optional

Shared file system Count usage

sfs_size_limit: number

Optional

Shared file system Size, GiB limit

sfs_size_requested: number

Optional

Shared file system Size, GiB requested

sfs_size_usage: number

Optional

Shared file system Size, GiB usage

shared_vm_count_limit: number

Optional

Basic VMs Count limit

shared_vm_count_requested: number

Optional

Basic VMs Count requested

shared_vm_count_usage: number

Optional

Basic VMs Count usage

snapshot_schedule_count_limit: number

Optional

Snapshot Schedules Count limit

snapshot_schedule_count_requested: number

Optional

Snapshot Schedules Count requested

snapshot_schedule_count_usage: number

Optional

Snapshot Schedules Count usage

subnet_count_limit: number

Optional

Subnets Count limit

subnet_count_requested: number

Optional

Subnets Count requested

subnet_count_usage: number

Optional

Subnets Count usage

vm_count_limit: number

Optional

Instances Dedicated Count limit

vm_count_requested: number

Optional

Instances Dedicated Count requested

vm_count_usage: number

Optional

Instances Dedicated Count usage

volume_count_limit: number

Optional

Volumes Count limit

volume_count_requested: number

Optional

Volumes Count requested

volume_count_usage: number

Optional

Volumes Count usage

volume_size_limit: number

Optional

Volumes Size, GiB limit

volume_size_requested: number

Optional

Volumes Size, GiB requested

volume_size_usage: number

Optional

Volumes Size, GiB usage

volume_snapshots_count_limit: number

Optional

Snapshots Count limit

volume_snapshots_count_requested: number

Optional

Snapshots Count requested

volume_snapshots_count_usage: number

Optional

Snapshots Count usage

volume_snapshots_size_limit: number

Optional

Snapshots Size, GiB limit

volume_snapshots_size_requested: number

Optional

Snapshots Size, GiB requested

volume_snapshots_size_usage: number

Optional

Snapshots Size, GiB usage

Request example

curl https://api.gcore.com/cloud/v2/instances/$PROJECT_ID/$REGION_ID/check_limits \
    -H 'Content-Type: application/json' \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "baremetal_basic_count_limit": 0,
  "baremetal_basic_count_requested": 1,
  "baremetal_basic_count_usage": 0,
  "baremetal_gpu_count_limit": 0,
  "baremetal_gpu_count_requested": 1,
  "baremetal_gpu_count_usage": 0,
  "baremetal_hf_count_limit": 0,
  "baremetal_hf_count_requested": 1,
  "baremetal_hf_count_usage": 0,
  "baremetal_infrastructure_count_limit": 0,
  "baremetal_infrastructure_count_requested": 1,
  "baremetal_infrastructure_count_usage": 0,
  "baremetal_network_count_limit": 0,
  "baremetal_network_count_requested": 1,
  "baremetal_network_count_usage": 0,
  "baremetal_storage_count_limit": 0,
  "baremetal_storage_count_requested": 1,
  "baremetal_storage_count_usage": 0,
  "caas_container_count_limit": 0,
  "caas_container_count_requested": 1,
  "caas_container_count_usage": 0,
  "caas_cpu_count_limit": 0,
  "caas_cpu_count_requested": 1,
  "caas_cpu_count_usage": 0,
  "caas_gpu_count_limit": 0,
  "caas_gpu_count_requested": 1,
  "caas_gpu_count_usage": 0,
  "caas_ram_size_limit": 0,
  "caas_ram_size_requested": 1,
  "caas_ram_size_usage": 0,
  "cluster_count_limit": 0,
  "cluster_count_requested": 1,
  "cluster_count_usage": 0,
  "cpu_count_limit": 0,
  "cpu_count_requested": 1,
  "cpu_count_usage": 0,
  "dbaas_postgres_cluster_count_limit": 0,
  "dbaas_postgres_cluster_count_requested": 1,
  "dbaas_postgres_cluster_count_usage": 0,
  "external_ip_count_limit": 0,
  "external_ip_count_requested": 1,
  "external_ip_count_usage": 0,
  "faas_cpu_count_limit": 0,
  "faas_cpu_count_requested": 1,
  "faas_cpu_count_usage": 0,
  "faas_function_count_limit": 0,
  "faas_function_count_requested": 1,
  "faas_function_count_usage": 0,
  "faas_namespace_count_limit": 0,
  "faas_namespace_count_requested": 1,
  "faas_namespace_count_usage": 0,
  "faas_ram_size_limit": 0,
  "faas_ram_size_requested": 1,
  "faas_ram_size_usage": 0,
  "firewall_count_limit": 0,
  "firewall_count_requested": 1,
  "firewall_count_usage": 0,
  "floating_count_limit": 0,
  "floating_count_requested": 1,
  "floating_count_usage": 0,
  "gpu_count_limit": 0,
  "gpu_count_requested": 1,
  "gpu_count_usage": 0,
  "image_count_limit": 0,
  "image_count_requested": 1,
  "image_count_usage": 0,
  "image_size_limit": 0,
  "image_size_requested": 1,
  "image_size_usage": 0,
  "ipu_count_limit": 0,
  "ipu_count_requested": 1,
  "ipu_count_usage": 0,
  "laas_topic_count_limit": 0,
  "laas_topic_count_requested": 1,
  "laas_topic_count_usage": 0,
  "loadbalancer_count_limit": 0,
  "loadbalancer_count_requested": 1,
  "loadbalancer_count_usage": 0,
  "network_count_limit": 0,
  "network_count_requested": 1,
  "network_count_usage": 0,
  "ram_limit": 0,
  "ram_requested": 1,
  "ram_usage": 0,
  "registry_count_limit": 0,
  "registry_count_requested": 1,
  "registry_count_usage": 0,
  "registry_storage_limit": 0,
  "registry_storage_requested": 1,
  "registry_storage_usage": 0,
  "router_count_limit": 0,
  "router_count_requested": 1,
  "router_count_usage": 0,
  "secret_count_limit": 0,
  "secret_count_requested": 1,
  "secret_count_usage": 0,
  "servergroup_count_limit": 0,
  "servergroup_count_requested": 1,
  "servergroup_count_usage": 0,
  "sfs_count_limit": 0,
  "sfs_count_requested": 1,
  "sfs_count_usage": 0,
  "sfs_size_limit": 0,
  "sfs_size_requested": 1,
  "sfs_size_usage": 0,
  "shared_vm_count_limit": 0,
  "shared_vm_count_requested": 1,
  "shared_vm_count_usage": 0,
  "snapshot_schedule_count_limit": 0,
  "snapshot_schedule_count_requested": 1,
  "snapshot_schedule_count_usage": 0,
  "subnet_count_limit": 0,
  "subnet_count_requested": 1,
  "subnet_count_usage": 0,
  "vm_count_limit": 0,
  "vm_count_requested": 1,
  "vm_count_usage": 0,
  "volume_count_limit": 0,
  "volume_count_requested": 1,
  "volume_count_usage": 0,
  "volume_size_limit": 0,
  "volume_size_requested": 1,
  "volume_size_usage": 0,
  "volume_snapshots_count_limit": 0,
  "volume_snapshots_count_requested": 1,
  "volume_snapshots_count_usage": 0,
  "volume_snapshots_size_limit": 0,
  "volume_snapshots_size_requested": 1,
  "volume_snapshots_size_usage": 0
}

Create Instance -> { tasks }

post/v2/instances/{project_id}/{region_id}

Create one or many instances or basic VMs. For Linux instances, use the 'username' and 'password' to create a new user. When only 'password' is provided, it is set as the password for the default user of the image. The 'user_data' is ignored when the 'password' is specified. Use the 'user_data' field to provide a cloud-init script in base64 to apply configurations to the instance. For Windows instances, the 'username' cannot be specified in the request. Use the 'password' field to set the password for the 'Admin' user on Windows. Use the 'user_data' field to provide a cloudbase-init script in base64 to create new users on Windows. The password of the Admin user cannot be updated via 'user_data'.

Delete Instance -> { tasks }

delete/v1/instances/{project_id}/{region_id}/{instance_id}

Delete instance

Detach Interface -> { tasks }

post/v1/instances/{project_id}/{region_id}/{instance_id}/detach_interface

Detach interface from instance

Get Instance Console URL -> { remote_console }

get/v1/instances/{project_id}/{region_id}/{instance_id}/get_console

Get instance console URL

Get Instance Metrics -> { count, results }

post/v1/instances/{project_id}/{region_id}/{instance_id}/metrics

Get instance metrics, including cpu, memory, network and disk metrics

Deprecated Get Instance Naming Restrictions That Are Applied To Specified Project And Region -> { custom_name_allowed, name_templates_limited, allowed_bm_name_templates, 3 more... }

get/v1/instances/{project_id}/{region_id}/available_names

Deprecated. Get instance naming restrictions that are applied to specified project and region.

Get Instance Security Groups -> { count, results }

get/v1/instances/{project_id}/{region_id}/{instance_id}/securitygroups

List of server security groups

List Instances -> OffsetPage<{ addresses, flavor, instance_created, 20 more... }>

get/v1/instances/{project_id}/{region_id}

The date and time stamp format in changes-since or changes-before should be ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. Values must be urlencoded. If the time zone is omitted, the UTC time zone is assumed. When both changes-since and changes-before are specified, the value of the changes-since must be earlier than or equal to the value of the changes-before.

List Flavors -> { count, results }

get/v1/flavors/{project_id}/{region_id}

Retrieve a list of flavors. When the include_prices query parameter is specified, the list shows prices. A client in trial mode gets all price values as 0. If you get Pricing Error contact the support

List Network Interfaces -> { count, results }

get/v1/instances/{project_id}/{region_id}/{instance_id}/interfaces

List network interfaces attached to the instance

List Network Ports -> { count, results }

get/v1/instances/{project_id}/{region_id}/{instance_id}/ports

List network ports of instance

Perform A Specific Action On An Instance -> { tasks }

post/v2/instances/{project_id}/{region_id}/{instance_id}/action

The action can be one of: start, stop, reboot, powercycle, suspend or resume. Suspend and resume are not available for baremetal instances.

Deprecated Powercycle Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/instances/{project_id}/{region_id}/{instance_id}/powercycle

Powercycle (stop and start) the instance, aka hard reboot

Put Instance Into The Server Group -> { tasks }

post/v1/instances/{project_id}/{region_id}/{instance_id}/put_into_servergroup

Put instance into the server group

Deprecated Reboot Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/instances/{project_id}/{region_id}/{instance_id}/reboot

Deprecated. Reboot instance

Remove Instance From The Server Group -> { tasks }

post/v1/instances/{project_id}/{region_id}/{instance_id}/remove_from_servergroup

Remove instance from the server group

Rename Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

patch/v1/instances/{project_id}/{region_id}/{instance_id}

Rename instance

Deprecated Resume Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/instances/{project_id}/{region_id}/{instance_id}/resume

Resume a suspended server to an active state.

Get Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

get/v1/instances/{project_id}/{region_id}/{instance_id}

Get instance

Search For Instance In All Clients Of The Reseller -> { count, results }

get/v1/instances/search

Search for instance in all clients of the reseller

Deprecated Start Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/instances/{project_id}/{region_id}/{instance_id}/start

Power on the server. Required VM state: Shutoff, Stopped

Deprecated Stop Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/instances/{project_id}/{region_id}/{instance_id}/stop

Power off the server. Required VM state: Active, Shutoff, Rescued

Deprecated Suspend Instance -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/instances/{project_id}/{region_id}/{instance_id}/suspend

When you suspend a server, its VM state is stored on disk, all memory is written to disk, and the virtual machine is stopped. Suspending a server is similar to placing a device in hibernation, and its occupied resource will not be freed but rather kept for when the server is resumed. Required VM state: Active, Shutoff

Un Assign Security Group ->

post/v1/instances/{project_id}/{region_id}/{instance_id}/delsecuritygroup

Un-assign the security group to the server. To un-assign multiple security groups to all ports, use the NULL value for the port_id field

Instances

App Templates

instances.app_templates

Methods

List Apptemplates -> { count, results }

get/v1/apptemplates/{project_id}/{region_id}

Retrieve marketplace application templates list. Application templates are used in instance creation API v2

Get Apptemplate -> { id, category, description, 14 more... }

get/v1/apptemplates/{project_id}/{region_id}/{apptemplate_id}

Get apptemplate

Instances

Available Flavors

instances.available_flavors

Methods

Get Flavors For Instance -> { count, results }

post/v1/instances/{project_id}/{region_id}/available_flavors

Get flavors available for a potential instance

Get Flavors To Resize Into -> { count, results }

get/v1/instances/{project_id}/{region_id}/{instance_id}/available_flavors

Get flavors available for the instance to resize into

Instances

Metadata

instances.metadata

Methods

Create Or Update Metadata ->

post/v1/instances/{project_id}/{region_id}/{instance_id}/metadata

Create or update one or more metadata items for an instance. If an item does not exist, it gets created in the server metadata. If an item already exists, it's value is overwritten

Delete Instance Metadata Item ->

delete/v1/instances/{project_id}/{region_id}/{instance_id}/metadata/{key}

Delete instance metadata item by key. This endpoint does not support special characters in keys. Use /v2/instances/.../metadata_item instead.

Get Instance Metadata Item -> { key, read_only, value }

get/v1/instances/{project_id}/{region_id}/{instance_id}/metadata/{key}

Get instance metadata item by key. This endpoint does not support special characters in keys. Use /v2/instances/.../metadata_item instead.

List Instance Metadata -> { count, results }

get/v1/instances/{project_id}/{region_id}/{instance_id}/metadata

Lists all metadata for an instance

Replace Metadata ->

put/v1/instances/{project_id}/{region_id}/{instance_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request

Instances

Metadata Item

instances.metadata_item

Methods

Delete Instance Metadata Item By Key ->

delete/v2/instances/{project_id}/{region_id}/{instance_id}/metadata_item

Delete instance metadata item by key

Get Instance Metadata Item By Key -> { key, read_only, value }

get/v2/instances/{project_id}/{region_id}/{instance_id}/metadata_item

Get instance metadata item by key

Instances

Reseller Name Templates

instances.reseller_name_templates

Methods

Delete The Reseller S Name Templates Setting And Drop All Naming Restrictions On The Region ->

delete/v1/reseller_name_templates/{reseller_id}/{region_id}

Delete the reseller's name_templates setting and drop all naming restrictions on the region.

Get Naming Restrictions That Are Applied To Specified Project And Region -> { custom_name_allowed, name_templates_limited, allowed_bm_name_templates, 5 more... }

get/v1/reseller_name_templates/{project_id}/{region_id}/available_names

Get naming restrictions that are applied to specified project and region.

List Name Template Configs Of The Reseller -> { count, results }

get/v1/reseller_name_templates

List name template configs of the reseller.

Update Or Create Reseller Naming Configuration -> { allow_custom_name, allowed_bm_name_templates, allowed_bm_name_win_templates, 7 more... }

put/v1/reseller_name_templates

Update or create reseller naming configuration.