Skip to content

Detach a network interface from a stopped instance

Synchronous. The instance must be stopped. The primary interface can't be detached (409 primary_interface).

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

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired

    UUID or prefixed ID (org_…)

  • projectIdstringrequired

    UUID or prefixed ID (prj_…)

  • instancestringrequired

    The instance's prefixed ID (ins_…) or its UUID.

Header parameters

  • Idempotency-Keyoptionalstring

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

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

Request bodyJSONrequired

  • networkInterfaceIdstringrequired

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

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

Returns

200

The instance, with the change.

JSON
  • architecturestringrequired
  • botobject | nullrequired

    The Bot attached to the instance: code on the instance gets short-lived API keys acting as it from the metadata service. null with none.

    2 properties
    • idstringrequired

      The Bot's bot_ ID.

      pattern: ^bot_[a-z0-9]{12}$
    • namestring | nullrequired

      The Bot's name on a single instance's read; null in lists, or when the Bot no longer exists.

  • cpuFamilysharedordedicatedrequired
  • createdAtstringrequired
    format: date-time
  • idstringrequired
    format: uuid
  • imageobjectrequired
    3 properties
    • aliasstringrequired

      The image alias the instance launched from; empty for a launch from an exact image ID or a root volume restored from a snapshot.

    • idstringrequired

      The exact image (img_…) the launch resolved; empty for a root restored from a snapshot.

    • sha256stringrequired

      The sha256 of the exact image the launch resolved; empty for a root restored from a snapshot.

  • instanceStoreobject | nullrequired

    Copied from the instance type when it was set; null for types without. Ephemeral: contents are lost when the instance stops, is terminated or moves to another host; a reboot keeps them.

    4 properties
    • disksintegerrequired
    • iopsinteger | nullrequired
    • sizeGiBintegerrequired
    • throughputMBpsinteger | nullrequired
  • instanceTypestringrequired
  • launchedAtstring | nullrequired
    format: date-time
  • memoryMiBintegerrequired
  • namestringrequired
  • networkInterfaceIdsarray ofstringrequired
  • organizationIdstringrequired
    format: uuid
  • primaryNetworkInterfaceIdstring | nullrequired
  • projectIdstringrequired
    format: uuid
  • regionstringrequired
  • resourceNamestringrequired
  • rootDevicevolumeorinstanceStorerequired

    Where the root lives: a block storage volume (rootVolumeId), or instance store disk 0 (rootVolumeId null; the instance can be rebooted and terminated but not stopped or resized).

  • rootVolumeIdstring | nullrequired
  • slugstringrequired
  • sshKeysarray ofobjectrequired
    2 properties
    • fingerprintstringrequired
    • idstringrequired
  • statuspendingorrunningorrebootingorstoppingorstoppedorstarting+5 morerequired
  • statusReasonobject | nullrequired
    2 properties
    • codestringrequired
    • messagestringrequired
  • tagsmap ofstringrequired

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

  • updatedAtstringrequired
    format: date-time
  • vcpusintegerrequired
  • volumeHotplugbooleanrequired

    Whether attach-volume and detach-volume work on the instance while it runs. False until the instance's first start after the feature was enabled, and while it's stopped.

  • volumeIdsarray ofstringrequired
  • statusChecksoptionalobject

    The instance's status checks, on get and list. system: problems EZGH fixes (the host, the VM process, volumes, the cell); instance: problems inside the guest (no answer to probes, a kernel panic).

    3 properties
    • instanceobjectrequired
      3 properties
      • checksarray ofobjectrequired
        4 properties
        • namestringrequired

          system: host, process, volumes; instance: reachability, kernel.

        • reasonobject | nullrequired
          3 properties
          • codestringrequired

            host_unreachable, cell_unreachable, migration_unresolved, instance_process_failed, volume_io_error, volume_io_stalled, no_probe_reply or kernel_panic.

          • messagestringrequired
          • detailoptionalmap ofstring

            volumeId for the volume reasons.

        • sincestring | nullrequired

          When this check entered its status; null before the cell first judged it.

          format: date-time
        • statuspassedorfailedorinitializingornot_applicableorunknownrequired
      • sincestringrequired
        format: date-time
      • statuspassedorfailedorinitializingornot_applicableorunknownrequired
    • systemobjectrequired
      3 properties
      • checksarray ofobjectrequired
        4 properties
        • namestringrequired

          system: host, process, volumes; instance: reachability, kernel.

        • reasonobject | nullrequired
          3 properties
          • codestringrequired

            host_unreachable, cell_unreachable, migration_unresolved, instance_process_failed, volume_io_error, volume_io_stalled, no_probe_reply or kernel_panic.

          • messagestringrequired
          • detailoptionalmap ofstring

            volumeId for the volume reasons.

        • sincestring | nullrequired

          When this check entered its status; null before the cell first judged it.

          format: date-time
        • statuspassedorfailedorinitializingornot_applicableorunknownrequired
      • sincestringrequired
        format: date-time
      • statuspassedorfailedorinitializingornot_applicableorunknownrequired
    • updatedAtstringrequired

      When the cell last changed the checks.

      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