Skip to main content

Create Committed

POST/api/v1/nodes/

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used for authenticating the request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringoptional

    Location identifier for the request

    • must be a non-empty string
    • should be URL-encoded if it contains special characters
    example{{location}}

Request body

application/json

object
labelstring

Identifier label for the committed resource

exampledefault
  • must be a non-empty string
  • max length 64 characters
namestring

Identifier for the committed resource

exampleC3-8GB-666
  • required and non-empty
  • may contain only alphanumeric characters and hyphens
regionstring

The region identifier for the committed resource.

examplencr
  • must be a non-empty string
  • lowercase letters only
  • must be a supported region code such as "ncr"
planstring

Identifier for the committed resource plan

exampleC3-4vCPU-8RAM-100DISK-C3-Onetemplate-Ubuntu24.04-Delhi
  • Must be a non-empty string
  • Allowed characters: letters, numbers, hyphens
imagestring

Identifier of the operating system image to use for the committed resource.

exampleUbuntu-24.04-Distro
  • must be a non-empty string
  • may contain alphanumeric characters, hyphens and periods only
is_privateboolean

Indicates whether the created commit should be private

examplefalse
  • must be a boolean
ssh_keysarray
start_scriptsarray
backupsboolean

Flag indicating whether to create backups for the committed request

examplefalse
  • must be a boolean value
  • optional field
enable_bitninjaboolean

Flag to enable BitNinja protection on creation

examplefalse
  • must be a boolean
  • optional; defaults to false
disable_passwordboolean

Flag indicating if the password should be disabled.

exampletrue
  • must be a boolean
is_saved_imageboolean

Indicates whether the image should be saved

examplefalse
  • must be a boolean
saved_image_template_idstring

Identifier of the saved image template to use

  • must be a valid UUID string
  • must reference an existing saved image template
reserve_ipstring

IP address to reserve for the committed resource

example
  • must be a valid IPv4 or IPv6 address
  • optional; omit or leave empty if no reservation is needed
is_ipv6_availedboolean

Indicates whether IPv6 service is availed

examplefalse
  • must be a boolean
  • required field
subnet_idstring

Identifier of the subnet where the commitment will be created

example
  • non-empty string
  • must match the provider's subnet ID format (e.g., "subnet-<hex>")
default_public_ipboolean

Indicates whether the committed resource should be assigned a public IP address.

examplefalse
  • must be a boolean
  • defaults to false when omitted
ngc_container_idstring

Identifier of the NGC container

  • if provided, must be a non-empty string
number_of_instancesinteger

Number of instances to create in the committed request

example1
  • must be a positive integer
  • minimum value is 1
security_group_idinteger

Identifier of the security group

example12345
  • required
  • must be a positive integer
cn_statusstring

Specifies the renewal mode for the committed resource.

exampleauto_renew
  • must be a non-empty string
  • allowed values: auto_renew, manual
cn_idinteger

Identifier of the committed record

example1234
  • required
  • must be a positive integer

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the create operation

example200
  • integer between 100 and 599
  • must represent a successful creation (e.g., 200 or 201)
dataobject
errorsobject
messagestring

Status message indicating the result of the create operation.

exampleSuccess
  • must be a non-empty string
  • maximum length of 255 characters