Skip to content

Launch an instance

Asynchronous: answers 202 with the CreateInstance operation once capacity is claimed and every volume, interface and firewall attachment is reserved. 409 insufficient_capacity when no cell has room.

POST
https://compute-api.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/instances

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired

    UUID or prefixed ID (org_…)

  • projectIdstringrequired

    UUID or prefixed ID (prj_…)

Header parameters

  • Idempotency-Keyoptionalstring

    Makes a retry safe: the same key and request get the stored response.

    pattern: ^[\x21-\x7e]{1,200}$

Request bodyJSONrequired

  • instanceTypestringrequired
  • namestringrequired
    maxLength: 100, minLength: 1
  • networkInterfacesarray ofobjectrequired
    6 properties
    • firewallIdsoptionalarray ofstring

      Omitted: the project's default firewall (for a private interface, its VPC's default firewall). []: none.

      pattern: ^fwl_[a-z0-9]{12}$
    • ipv4optionalboolean

      A public IPv4 address. On a private interface it is mapped onto the interface's primary private IPv4 (the instance never sees it) and needs the VPC's network gateway (409 vpc_has_no_gateway). Omitted: none on a public interface; with subnet, the subnet's autoAssignPublicIpv4 decides.

    • ipv6optionalboolean

      Only with subnet: a public IPv6 /64 on the private interface, configured on the instance; needs the VPC's network gateway (409 vpc_has_no_gateway). Omitted, the subnet's autoAssignPublicIpv6 decides.

    • networkInterfaceIdoptionalstring

      An existing interface's eni_ ID (a UUID is 400 invalid_request).

      pattern: ^eni_[a-z0-9]{12}$
    • privateIpv4Addressoptionalstring

      The private interface's primary IPv4 address, a usable address of its subnet; omitted, the lowest free one. Only with subnet.

      format: ipv4
    • subnetoptionalstring

      A VPC subnet (sbn_…) of this project: the interface is private, with a primary private IPv4 and IPv6 address in it. It may be the primary (index 0): then no other interface may be public (409 primary_is_private).

      pattern: ^sbn_[a-z0-9]{12}$
  • botoptionalstring

    A Bot of the organization (its bot_ ID) to attach: code on the instance gets short-lived API keys acting as it from the metadata service. Needs bots.pass on the Bot (403 access_denied naming bots.pass). An unknown Bot or a UUID is 400 invalid_request at bot.

    pattern: ^bot_[a-z0-9]{12}$
  • imageoptionalstring

    An image alias, such as linux/ubuntu:24.04, or an exact image ID (img_…) this project may launch: its own or a public platform image. Required unless rootVolume.snapshotId restores the root volume from a snapshot.

  • rootDeviceoptionalvolumeorinstanceStore

    instanceStore boots from the type's first instance store disk (store0): the type must have instanceStore (400 invalid_request at rootDevice), rootVolume must be absent (400 at rootVolume), the image must fit the disk (400 image_too_large), and the instance can't be stopped or resized (409 instance_store_root). Its rootVolumeId is null.

    Default: "volume"
  • rootVolumeoptionalobject
    5 properties
    • iopsoptionalinteger | null
    • sizeGiBoptionalinteger

      Omitted: the image's minimum size, rounded up to whole GiB, or the snapshot's volume size.

      minimum: 1
    • snapshotIdoptionalstring

      A snapshot (snp_…) of this project to restore the root volume from, in place of image. The caller needs blockstore.snapshots.restore on it.

    • throughputMBpsoptionalinteger | null
    • volumeTypeoptionalstring

      A volume type from the block store's catalog. Omitted: the catalog's default type; a region whose catalog has no default answers 400 at rootVolume.volumeType, so name one. A root from a snapshot keeps the snapshot's type, and omitted takes it.

  • sshKeyIdsoptionalarray ofstring
    pattern: ^ssh_[a-z0-9]{12}$
  • tagsoptionalmap ofstring

    At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.

  • userDataoptionalstring

    Base64, at most 16 KiB decoded. Never recorded.

  • volumesoptionalarray ofobject
    5 properties
    • iopsoptionalinteger | null
    • sizeGiBoptionalinteger
      minimum: 1
    • throughputMBpsoptionalinteger | null
    • volumeIdoptionalstring

      An existing volume's vol_ ID (a UUID is 400 invalid_request).

      pattern: ^vol_[a-z0-9]{12}$
    • volumeTypeoptionalstring

Returns

202

The operation, which Location names; poll it until it finishes.

JSON
  • actionstringrequired
  • cancellablebooleanrequired
  • createdAtstringrequired
    format: date-time
  • createdByobjectrequired
    2 properties
    • idstringrequired
    • typeuserorbotorssoUserorservicerequired
  • errorobject | nullrequired

    A failed operation's error, { code, message }.

  • finishedAtstring | nullrequired
    format: date-time
  • idstringrequired
    format: uuid
  • organizationIdstringrequired
    format: uuid
  • projectIdstring | nullrequired
    format: uuid
  • startedAtstring | nullrequired
    format: date-time
  • statusqueuedorrunningorsucceededorfailedorcancelledrequired
  • targetobjectrequired
    3 properties
    • idstringrequired
    • resourceNamestringrequired
    • typestringrequired
  • typestringrequired
  • updatedAtstringrequired
    format: date-time

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close