Instance Type Capacity

Controlling the capacity of each instance type

Get the details of all your instance type capacities under a host capacity template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The ID of the hostCapacityTemplate

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Instance Type Capacity

hostCapacityTemplateIdstringRead-onlyRequired

The ID of the Host Capacity Template to which this element is linked

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

instanceTypestringRequired

The instance type to which the capacity applies. This is the name of instance types found at various cloud providers. See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)

isVirtualinteger · integerRead-onlyRequired

1 if the instance type is a virtual server, 0 if it is a bare metal server

capacityinteger · integerRequired

The capacity of the instance type

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity

HTTPcURLJavaScriptPython

GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "hostCapacityTemplateId": "text",
    "providerId": 1,
    "instanceType": "text",
    "isVirtual": 1,
    "capacity": 1,
    "createdAt": 1
  }
]

Create an instance type capacity for the specified hostCapacityTemplateId

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The ID of the hostCapacityTemplate

Body

application/json

idstringRead-onlyRequired

The ID of the Instance Type Capacity

hostCapacityTemplateIdstringRead-onlyRequired

The ID of the Host Capacity Template to which this element is linked

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

instanceTypestringRequired

The instance type to which the capacity applies. This is the name of instance types found at various cloud providers. See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)

isVirtualinteger · integerRead-onlyRequired

1 if the instance type is a virtual server, 0 if it is a bare metal server

capacityinteger · integerRequired

The capacity of the instance type

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Instance Type Capacity

hostCapacityTemplateIdstringRead-onlyRequired

The ID of the Host Capacity Template to which this element is linked

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

instanceTypestringRequired

The instance type to which the capacity applies. This is the name of instance types found at various cloud providers. See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)

isVirtualinteger · integerRead-onlyRequired

1 if the instance type is a virtual server, 0 if it is a bare metal server

capacityinteger · integerRequired

The capacity of the instance type

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post/v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity

HTTPcURLJavaScriptPython

POST /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "providerId": 1,
  "instanceType": "text",
  "capacity": 1
}

[
  {
    "id": "text",
    "hostCapacityTemplateId": "text",
    "providerId": 1,
    "instanceType": "text",
    "isVirtual": 1,
    "capacity": 1,
    "createdAt": 1
  }
]

Get the details of the given instance type capacity

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

instanceTypeCapacityIdstringRequired

The Id of the instance type capacity

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Instance Type Capacity

hostCapacityTemplateIdstringRead-onlyRequired

The ID of the Host Capacity Template to which this element is linked

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

instanceTypestringRequired

The instance type to which the capacity applies. This is the name of instance types found at various cloud providers. See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)

isVirtualinteger · integerRead-onlyRequired

1 if the instance type is a virtual server, 0 if it is a bare metal server

capacityinteger · integerRequired

The capacity of the instance type

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

404

Invalid instanceTypeCapacityId

500

Internal Server Error

application/json

get/v3/instanceTypeCapacity/{instanceTypeCapacityId}

HTTPcURLJavaScriptPython

GET /v3/instanceTypeCapacity/{instanceTypeCapacityId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "hostCapacityTemplateId": "text",
    "providerId": 1,
    "instanceType": "text",
    "isVirtual": 1,
    "capacity": 1,
    "createdAt": 1
  }
]

Update given host capacity template

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

instanceTypeCapacityIdstringRequired

The Id of the host capacity template

Body

application/json

idstringRead-onlyRequired

The ID of the Instance Type Capacity

hostCapacityTemplateIdstringRead-onlyRequired

The ID of the Host Capacity Template to which this element is linked

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

instanceTypestringRequired

The instance type to which the capacity applies. This is the name of instance types found at various cloud providers. See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)

isVirtualinteger · integerRead-onlyRequired

1 if the instance type is a virtual server, 0 if it is a bare metal server

capacityinteger · integerRequired

The capacity of the instance type

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Instance Type Capacity

hostCapacityTemplateIdstringRead-onlyRequired

The ID of the Host Capacity Template to which this element is linked

providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

instanceTypestringRequired

The instance type to which the capacity applies. This is the name of instance types found at various cloud providers. See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)

isVirtualinteger · integerRead-onlyRequired

1 if the instance type is a virtual server, 0 if it is a bare metal server

capacityinteger · integerRequired

The capacity of the instance type

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

404

Invalid instanceTypeCapacityId

422

Unprocessable Entity

500

Internal Server Error

application/json

put/v3/instanceTypeCapacity/{instanceTypeCapacityId}

HTTPcURLJavaScriptPython

PUT /v3/instanceTypeCapacity/{instanceTypeCapacityId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "providerId": 1,
  "instanceType": "text",
  "capacity": 1
}

[
  {
    "id": "text",
    "hostCapacityTemplateId": "text",
    "providerId": 1,
    "instanceType": "text",
    "isVirtual": 1,
    "capacity": 1,
    "createdAt": 1
  }
]

Delete given host capacity template

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

instanceTypeCapacityIdstringRequired

The Id of the host capacity template

Responses

204

No Content

No content

403

Invalid credentials

404

Invalid instanceTypeCapacityId

409

Cannot delete

500

Internal Server Error

application/json

delete/v3/instanceTypeCapacity/{instanceTypeCapacityId}

HTTPcURLJavaScriptPython

DELETE /v3/instanceTypeCapacity/{instanceTypeCapacityId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content