# Models

## The APILog object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"APILog":{"type":"object","required":["request","response"],"properties":{"request":{"allOf":[{"$ref":"#/components/schemas/APIRequest"}],"description":"HTTP request object","readOnly":true},"response":{"allOf":[{"$ref":"#/components/schemas/APIResponse"}],"description":"HTTP response object","readOnly":true}},"additionalProperties":false},"APIRequest":{"type":"object","required":["url","method","header","queryParameter","ipAddress","requestTimestamp","body"],"properties":{"url":{"type":"string","format":"","description":"Url of the request","readOnly":true},"method":{"type":"string","format":"","description":"The Http method that was used in the request. Possible values are:\n* GET\n* POST\n* PUT\n* DELETE","readOnly":true},"header":{"type":"object","additionalProperties":false,"description":"Any headers that were sent in the request","readOnly":true},"queryParameter":{"type":"string","format":"","description":"Any query parameters that were passed in the request","readOnly":true},"ipAddress":{"type":"string","format":"","description":"IP address of the client that performed the request","readOnly":true},"requestTimestamp":{"type":"integer","format":"integer","description":"The unix timestamp at which the API received the request","readOnly":true},"body":{"type":"object","additionalProperties":false,"anyOf":[{"type":"object"},{"type":"array"}],"description":"The (optional) body of the request","nullable":true,"readOnly":true}},"additionalProperties":false},"APIResponse":{"type":"object","required":["responseTime","code","body"],"properties":{"responseTime":{"type":"number","format":"float","description":"The time it took from the moment we receive the request from the webserver till the moment we send it back to the client, measured in seconds","readOnly":true},"code":{"type":"integer","format":"integer","description":"HTTP response status code","readOnly":true},"body":{"type":"object","additionalProperties":false,"anyOf":[{"type":"object"},{"type":"array"}],"description":"The body of the response, in case of GET method body will be null","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The APIRequest object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"APIRequest":{"type":"object","required":["url","method","header","queryParameter","ipAddress","requestTimestamp","body"],"properties":{"url":{"type":"string","format":"","description":"Url of the request","readOnly":true},"method":{"type":"string","format":"","description":"The Http method that was used in the request. Possible values are:\n* GET\n* POST\n* PUT\n* DELETE","readOnly":true},"header":{"type":"object","additionalProperties":false,"description":"Any headers that were sent in the request","readOnly":true},"queryParameter":{"type":"string","format":"","description":"Any query parameters that were passed in the request","readOnly":true},"ipAddress":{"type":"string","format":"","description":"IP address of the client that performed the request","readOnly":true},"requestTimestamp":{"type":"integer","format":"integer","description":"The unix timestamp at which the API received the request","readOnly":true},"body":{"type":"object","additionalProperties":false,"anyOf":[{"type":"object"},{"type":"array"}],"description":"The (optional) body of the request","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The APIResponse object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"APIResponse":{"type":"object","required":["responseTime","code","body"],"properties":{"responseTime":{"type":"number","format":"float","description":"The time it took from the moment we receive the request from the webserver till the moment we send it back to the client, measured in seconds","readOnly":true},"code":{"type":"integer","format":"integer","description":"HTTP response status code","readOnly":true},"body":{"type":"object","additionalProperties":false,"anyOf":[{"type":"object"},{"type":"array"}],"description":"The body of the response, in case of GET method body will be null","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The AccessDocument object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccessDocument":{"type":"object","required":["id","documentType","documentNumber","documentExpiration"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the document","readOnly":true},"documentType":{"type":"integer","format":"integer","description":"Type of the document"},"documentNumber":{"type":"string","format":"","description":"Number of document"},"documentExpiration":{"type":"string","format":"","description":"Expiration date of document"}},"additionalProperties":false}}}}
```

## The AccountAPIKeyIPWhitelist object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountAPIKeyIPWhitelist":{"type":"object","required":["id","active","updatedAt"],"properties":{"id":{"type":"integer","format":"integer","description":"Whitelist ID","readOnly":true},"ipStart":{"type":"string","format":"","description":"Start IP of API key IP whitelist range","nullable":true},"ipEnd":{"type":"string","format":"","description":"End IP of API key IP whitelist range","nullable":true},"ipRange":{"type":"string","format":"","description":"CIDR IP range of API key whitelist","nullable":true},"comments":{"type":"string","format":"","description":"IP whitelist range comments","nullable":true},"active":{"type":"integer","format":"integer","description":"Whether or not this IP whitelist range is active"},"updatedAt":{"type":"integer","format":"integer","description":"Last time this IP whitelist range was updated","readOnly":true}},"additionalProperties":false}}}}
```

## The AccountActionLog object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountActionLog":{"type":"object","required":["remoteIP","title","description","date","time","timestamp"],"properties":{"remoteIP":{"type":"string","format":"","description":"Remote ip address","readOnly":true},"title":{"type":"string","format":"","description":"Title Of The action","readOnly":true},"description":{"type":"string","format":"","description":"A description about the action","readOnly":true},"date":{"type":"string","format":"","description":"Log creation date","readOnly":true,"deprecated":true},"time":{"type":"string","format":"","description":"Log creation time","readOnly":true,"deprecated":true},"timestamp":{"type":"integer","format":"integer","description":"The unix time at which the log was created","readOnly":true}},"additionalProperties":false}}}}
```

## The AccountApiKey object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountApiKey":{"type":"object","required":["id","category","key","assignOdpServerIps","used"],"properties":{"id":{"type":"integer","format":"integer","description":"API key ID","readOnly":true},"category":{"type":"integer","format":"integer","description":"API key access category"},"key":{"type":"string","format":"","description":"API key","readOnly":true},"note":{"type":"string","format":"","description":"API key note","nullable":true},"assignOdpServerIps":{"type":"integer","format":"integer","description":"Whether or not to assign ODP server IPs"},"used":{"type":"integer","format":"integer","description":"Number of times that the API key was used","readOnly":true},"expiresAt":{"type":"integer","format":"integer","description":"API key expiration time as UNIX timestamp","nullable":true}},"additionalProperties":false}}}}
```

## The AccountBillingDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountBillingDetails":{"type":"object","required":["firstName","lastName","address","streetNumber","zipCode","city","countryCode","bundleInvoicesOfSameCategory","receivePaymentConfirmationsViaEmail","preferredPaymentMethod"],"properties":{"firstName":{"type":"string","format":"","description":"Billing first name."},"lastName":{"type":"string","format":"","description":"Billing last name."},"address":{"type":"string","format":"","description":"Billing address."},"streetNumber":{"type":"string","format":"","description":"Billing street number."},"zipCode":{"type":"string","format":"","description":"Billing ZIP code."},"city":{"type":"string","format":"","description":"Billing city."},"countryCode":{"type":"string","format":"","description":"Country code in ISO 3166-1 alpha-2 format."},"phoneNumber":{"type":"string","format":"","description":"Billing phone number. Either this or phoneNumberMobile is required.","nullable":true},"phoneNumberMobile":{"type":"string","format":"","description":"Billing mobile phone number. Either this or phoneNumber is required.","nullable":true},"emailAddressBilling":{"type":"string","format":"","description":"Email address for billing emails","nullable":true},"bundleInvoicesOfSameCategory":{"type":"integer","format":"integer","description":"Whether or not to bundle invoices of the same category"},"receivePaymentConfirmationsViaEmail":{"type":"integer","format":"integer","description":"Whether or not to send email confirmations via email"},"preferredPaymentMethod":{"type":"integer","format":"integer","description":"Preferred payment method"}},"additionalProperties":false}}}}
```

## The AccountDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountDetails":{"type":"object","required":["accountType","firstName","lastName","address","streetNumber","zipCode","city","countryCode","emailAddress","unconfirmedEmail","emailAddressValidated","language","agreeDpa","isAllowedFlexMetal"],"properties":{"accountType":{"type":"integer","format":"integer","description":"Account type: 1 - consumer, 2 - business. Can only be updated by submitting a support ticket."},"companyName":{"type":"string","format":"","description":"Company name (for business accounts). Can only be updated by submitting a support ticket.","nullable":true},"vatNumber":{"type":"string","format":"","description":"VAT number (for business accounts). Can only be updated by submitting a support ticket.","nullable":true},"cocNumber":{"type":"string","format":"","description":"CoC number (only for Netherlands accounts). Can only be updated by submitting a support ticket.","nullable":true},"firstName":{"type":"string","format":"","description":"First name."},"lastName":{"type":"string","format":"","description":"Last name."},"address":{"type":"string","format":"","description":"Address - street name."},"streetNumber":{"type":"string","format":"","description":"House number"},"zipCode":{"type":"string","format":"","description":"ZIP / Post code."},"city":{"type":"string","format":"","description":"City."},"countryCode":{"type":"string","format":"","description":"Country code in ISO 3166-1 alpha-2 format."},"emailAddress":{"type":"string","format":"","description":"Email address","readOnly":true},"unconfirmedEmail":{"allOf":[{"$ref":"#/components/schemas/UnconfirmedEmail"}],"description":"Email address which is not confirmed yet","nullable":true,"readOnly":true},"emailAddressValidated":{"type":"integer","format":"integer","description":"Whether or not email address has been confirmed","nullable":true,"readOnly":true},"phoneNumber":{"type":"string","format":"","description":"Phone number. Either this or phoneNumberMobile is required","nullable":true},"phoneNumberMobile":{"type":"string","format":"","description":"Mobile phone number. Either this or phoneNumber is required","nullable":true},"language":{"type":"integer","format":"integer","description":"Preferred language: 0 - english, 1 - dutch"},"emailAddressAbuse":{"type":"string","format":"","description":"Email address for abuse emails","nullable":true},"newsletter":{"type":"integer","format":"integer","description":"Whether or not newsletter is subscribed to","nullable":true},"agreeToc":{"type":"integer","format":"integer","description":"Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.","nullable":true},"agreeAup":{"type":"integer","format":"integer","description":"Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.","nullable":true},"agreeDpa":{"type":"integer","format":"integer","description":"Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.","nullable":true},"isAllowedFlexMetal":{"type":"integer","format":"integer","description":"Whether or not the user is allowed to order flexmetal servers."}},"additionalProperties":false},"UnconfirmedEmail":{"type":"object","required":["email","expiresAt"],"properties":{"email":{"type":"string","format":"","description":"Email address which is not confirmed yet"},"expiresAt":{"type":"integer","format":"integer","description":"Expiry time of confirmation link","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The AccountDocument object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountDocument":{"type":"object","required":["id","documentType","documentNumber","documentExpiration"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the document","readOnly":true},"documentType":{"type":"integer","format":"integer","description":"Type of the document"},"documentNumber":{"type":"string","format":"","description":"Number of document"},"documentExpiration":{"type":"string","format":"","description":"Expiration date of document"}},"additionalProperties":false}}}}
```

## The AccountFile object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountFile":{"type":"object","required":["id","category","name","filename","type","size","uploadedAt"],"properties":{"id":{"type":"integer","format":"integer","description":"File ID","readOnly":true},"category":{"type":"integer","format":"integer","description":"ID of the category of the file"},"name":{"type":"string","format":"","description":"File display name"},"filename":{"type":"string","format":"","description":"Name of the file"},"type":{"type":"string","format":"","description":"File MIME type","readOnly":true},"size":{"type":"integer","format":"integer","description":"File size in bytes","readOnly":true},"uploadedAt":{"type":"integer","format":"integer","description":"UNIX timestamp of when the file was uploaded","readOnly":true}},"additionalProperties":false}}}}
```

## The AccountIPWhitelist object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountIPWhitelist":{"type":"object","required":["id","active","createdAt"],"properties":{"id":{"type":"integer","format":"integer","description":"IP whitelist ID","readOnly":true},"ipStart":{"type":"string","format":"","description":"First IP in range","nullable":true},"ipEnd":{"type":"string","format":"","description":"Last IP in range","nullable":true},"ipRange":{"type":"string","format":"","description":"IP range with network suffix such as /24, /32, etc.","nullable":true},"description":{"type":"string","format":"","description":"Description of whitelisted IP or range"},"active":{"type":"integer","format":"integer","description":"Whether or not this whitelist entry is active"},"createdAt":{"type":"integer","format":"integer","description":"Unix timestamp of when the IP whitelisting was created","readOnly":true}},"additionalProperties":false}}}}
```

## The AccountSignUp object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"AccountSignUp":{"type":"object","required":["emailAddress","password","firstName","lastName","newsletter","agreeToc","agreeAup","agreeDpa"],"properties":{"emailAddress":{"type":"string","format":"","description":"New Account Email Address"},"password":{"type":"string","format":"","description":"New Account Password"},"firstName":{"type":"string","format":"","description":"First name."},"lastName":{"type":"string","format":"","description":"Last name."},"newsletter":{"type":"integer","format":"integer","description":"Whether or not newsletter is subscribed to"},"agreeToc":{"type":"integer","format":"integer","description":"Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing."},"agreeAup":{"type":"integer","format":"integer","description":"Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing."},"agreeDpa":{"type":"integer","format":"integer","description":"Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing."}},"additionalProperties":false}}}}
```

## The ApplicationInstanceStopMethod object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceStopMethod":{"type":"object","properties":{"methodId":{"type":"integer","format":"integer","description":"Stop method type, list of types can be found in: [GET /v3/application/stopMethod](game-publisher#/Application/getApplicationStopMethods)"},"timeout":{"type":"integer","format":"integer","description":"Stop method timeout in seconds, default value is 1800 seconds."}},"additionalProperties":false}}}}
```

## The CDNUserFeaturesModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CDNUserFeaturesModel":{"type":"object","required":["type","features"],"properties":{"type":{"type":"string","format":""},"features":{"type":"array","items":{"$ref":"#/components/schemas/FeatureModel"}}},"additionalProperties":false},"FeatureModel":{"type":"object","required":["geometry","properties"],"properties":{"geometry":{"$ref":"#/components/schemas/GeometryModel"},"properties":{"$ref":"#/components/schemas/PropertiesModel"}},"additionalProperties":false},"GeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":"","description":"The type of the geometry"},"coordinates":{"type":"array","items":{"type":"number","format":"float"},"description":"The geographic coordinates"}},"additionalProperties":false},"PropertiesModel":{"type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"integer","description":"The heat value for the coordinate"}},"additionalProperties":false}}}}
```

## The CPUTriggerRule object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CPUTriggerRule":{"type":"object","required":["operator","triggerWindow","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET /v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"triggerWindow":{"type":"integer","format":"integer","description":"The time window for a rule, time will be in seconds"},"threshold":{"type":"integer","format":"integer","description":"The percentage of cpu (between 0 and 100%) usage were the event should be triggered on"}},"additionalProperties":false}}}}
```

## The CalcCategory object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcCategory":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of a category"},"name":{"type":"string","format":"","description":"Name of a category"}},"additionalProperties":false}}}}
```

## The CalcCategoryLocation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcCategoryLocation":{"type":"object","required":["categoryIds","locationId","countryName","countryNameShort","regionId","regionName","continent","city","locationBwPriceDedi","locationBwOverusePriceDedi","locationBwPriceColo","locationBwOverusePriceColo"],"properties":{"categoryIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"Category IDs"},"locationId":{"type":"integer","format":"integer","description":"Location ID"},"countryName":{"type":"string","format":"","description":"Name of the country of this location"},"countryNameShort":{"type":"string","format":"","description":"Name of the country of this location"},"regionId":{"type":"integer","format":"integer","description":"Region ID"},"regionName":{"type":"string","format":"","description":"Name of the region this location is situated in (regions are smaller than continents, but may be a whole continent)."},"continent":{"type":"string","format":"","description":"Name of the continent of this location"},"city":{"type":"string","format":"","description":"Name of the city of this location"},"locationBwPriceDedi":{"type":"integer","format":"integer","description":"Dedicated server bandwidth price per TB for this location, in cents"},"locationBwOverusePriceDedi":{"type":"integer","format":"integer","description":"Dedicated server bandwidth overuse price per TB for this location, in cents"},"locationBwPriceColo":{"type":"integer","format":"integer","description":"Colocation bandwidth price per TB for this location, in cents"},"locationBwOverusePriceColo":{"type":"integer","format":"integer","description":"Colocation bandwidth overuse price per TB for this location, in cents"}},"additionalProperties":false}}}}
```

## The CalcCategoryMargins object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcCategoryMargins":{"type":"object","required":["resellerTypeId","resellerTypeName","categoryId","marginFactor"],"properties":{"resellerTypeId":{"type":"integer","format":"integer","description":"ID of a reseller type"},"resellerTypeName":{"type":"string","format":"","description":"Name of a reseller type"},"categoryId":{"type":"integer","format":"integer","description":"ID of the category"},"marginFactor":{"type":"number","format":"float","description":"ID of a category"}},"additionalProperties":false}}}}
```

## The CalcConfig object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcConfig":{"type":"object","required":["id","tag","locationId","price","setup","flags","bwPriceDedi","bwPriceColo","fixed","noDowngrade","instantDeliverable","groups"],"properties":{"id":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration ID"},"tag":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration tag"},"locationId":{"type":"integer","format":"integer","description":"Location ID, as provided by /locations"},"price":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration price in cents"},"setup":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration setup price in cents"},"flags":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration flags\nIMMUTABLE         1;\nINSTANT_CONFIG    2;\nALLOW_DOWNGRADE   4;\nIS_DEAL           8;\nON_DEAL_PAGE      16;\nCOLO_NO_CONN      32;\nPRIVATE_CONFIG    64;"},"bwPriceDedi":{"type":"integer","format":"integer","description":"TB price for dedicated servers, in cents"},"bwPriceColo":{"type":"integer","format":"integer","description":"TB price for colocation, in cents"},"fixed":{"type":"boolean","description":"Whether this configuration is adjustable"},"noDowngrade":{"type":"boolean","description":"Whether items in this configuration can be downgraded"},"instantDeliverable":{"type":"boolean","description":"Whether this configuration can be setup instantly and automatically (low wait time)"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CalcGroup"},"description":"All item groups for this configuration"}},"additionalProperties":false},"CalcGroup":{"type":"object","required":["id","name","code","type","fixed","step","flags","noDowngrade","displayOrder","dependencyGroupId","dependencyItemIds","notes","items","defaultItemId"],"properties":{"id":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration group ID"},"name":{"type":"string","format":"","description":"ApplicationInstanceConfiguration group name"},"code":{"type":"string","format":"","description":"ApplicationInstanceConfiguration group code"},"type":{"type":"string","format":"","description":"ApplicationInstanceConfiguration group type (a human readable unique identifier)"},"fixed":{"type":"boolean","description":"Whether items in this configuration group are adjustable"},"step":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration group divider (for visual differentiation between related groups)"},"flags":{"type":"integer","format":"integer","description":"FLAG_HASQUANTITY                  1\nFLAG_HASPRICE                     2\nFLAG_ALLOW_EMPTY_SELECTION        4\nFLAG_INCLUDE_ON_INVOICE_IF_EMPTY  8\nFLAG_NOTE_ACTIVE                  16\nFLAG_APPLY_PERIOD_DISCOUNT        32\nFLAG_EXCLUDE_FROM_UPGRADES        64"},"noDowngrade":{"type":"boolean","description":"Whether items in this configuration group can be downgraded"},"displayOrder":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration group display order"},"dependencyGroupId":{"type":"integer","format":"integer","description":"If > 0, this group will only relevant / shown if the dependency group and/or item is selected."},"dependencyItemIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"If dependencyGroupId > 0, this group will only relevant / shown if (one of) these dependencyItemIds are selected."},"notes":{"type":"string","format":"","description":"Optional notes for a group, for displaying purposes."},"items":{"type":"array","items":{"$ref":"#/components/schemas/CalcItem"},"description":"All items for this configuration group"},"defaultItemId":{"type":"integer","format":"integer","description":"Default item in a group"}},"additionalProperties":false},"CalcItem":{"type":"object","required":["id","code","name","shortName","ident","quantity","specifications","flags","price","setupPrice","priceLinkGroupId","priceLinkPercentage","displayOrder","excludeConfigs","excludeLocationIds"],"properties":{"id":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration item ID"},"code":{"type":"string","format":"","description":"ApplicationInstanceConfiguration item code"},"name":{"type":"string","format":"","description":"Item name"},"shortName":{"type":"string","format":"","description":"Item name short"},"ident":{"type":"string","format":"","description":"Item human readable unique identifier"},"quantity":{"type":"integer","format":"integer","description":"Item quantity"},"specifications":{"type":"array","items":{"$ref":"#/components/schemas/CalcItemSpecification"},"description":"Item specifications"},"flags":{"type":"integer","format":"integer","description":"FLAG_NOTE_ACTIVE 1"},"price":{"type":"integer","format":"integer","description":"Item price in cents"},"setupPrice":{"type":"integer","format":"integer","description":"Item setup price in cents"},"priceLinkGroupId":{"type":"integer","format":"integer","description":"Item price is dependent on the price of this group or the entire order.\nIf -1, the price is a percentage (priceLinkPercentage) of the order.\nIf > 0, the price is a percentage (priceLinkPercentage) of the indicated group."},"priceLinkPercentage":{"type":"number","format":"float","description":"The percentage as refered to by priceLinkGroupId description."},"displayOrder":{"type":"integer","format":"integer","description":"Item display order"},"excludeConfigs":{"type":"array","items":{"type":"integer","format":"integer"},"description":"ApplicationInstanceConfiguration IDs from which this item must be excluded."},"excludeLocationIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"Location IDs from which this item must be excluded."}},"additionalProperties":false},"CalcItemSpecification":{"type":"object","required":["id","name","value","dataType","mandatory"],"properties":{"id":{"type":"integer","format":"integer","description":"Item specification ID"},"name":{"type":"string","format":"","description":"Item specification name"},"value":{"type":"string","format":"","description":"Item specification value"},"dataType":{"type":"string","format":"","description":"Item specification data type (int, float, string)"},"mandatory":{"type":"integer","format":"integer","description":"Whether this item specification is mandatory"}},"additionalProperties":false}}}}
```

## The CalcGroup object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcGroup":{"type":"object","required":["id","name","code","type","fixed","step","flags","noDowngrade","displayOrder","dependencyGroupId","dependencyItemIds","notes","items","defaultItemId"],"properties":{"id":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration group ID"},"name":{"type":"string","format":"","description":"ApplicationInstanceConfiguration group name"},"code":{"type":"string","format":"","description":"ApplicationInstanceConfiguration group code"},"type":{"type":"string","format":"","description":"ApplicationInstanceConfiguration group type (a human readable unique identifier)"},"fixed":{"type":"boolean","description":"Whether items in this configuration group are adjustable"},"step":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration group divider (for visual differentiation between related groups)"},"flags":{"type":"integer","format":"integer","description":"FLAG_HASQUANTITY                  1\nFLAG_HASPRICE                     2\nFLAG_ALLOW_EMPTY_SELECTION        4\nFLAG_INCLUDE_ON_INVOICE_IF_EMPTY  8\nFLAG_NOTE_ACTIVE                  16\nFLAG_APPLY_PERIOD_DISCOUNT        32\nFLAG_EXCLUDE_FROM_UPGRADES        64"},"noDowngrade":{"type":"boolean","description":"Whether items in this configuration group can be downgraded"},"displayOrder":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration group display order"},"dependencyGroupId":{"type":"integer","format":"integer","description":"If > 0, this group will only relevant / shown if the dependency group and/or item is selected."},"dependencyItemIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"If dependencyGroupId > 0, this group will only relevant / shown if (one of) these dependencyItemIds are selected."},"notes":{"type":"string","format":"","description":"Optional notes for a group, for displaying purposes."},"items":{"type":"array","items":{"$ref":"#/components/schemas/CalcItem"},"description":"All items for this configuration group"},"defaultItemId":{"type":"integer","format":"integer","description":"Default item in a group"}},"additionalProperties":false},"CalcItem":{"type":"object","required":["id","code","name","shortName","ident","quantity","specifications","flags","price","setupPrice","priceLinkGroupId","priceLinkPercentage","displayOrder","excludeConfigs","excludeLocationIds"],"properties":{"id":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration item ID"},"code":{"type":"string","format":"","description":"ApplicationInstanceConfiguration item code"},"name":{"type":"string","format":"","description":"Item name"},"shortName":{"type":"string","format":"","description":"Item name short"},"ident":{"type":"string","format":"","description":"Item human readable unique identifier"},"quantity":{"type":"integer","format":"integer","description":"Item quantity"},"specifications":{"type":"array","items":{"$ref":"#/components/schemas/CalcItemSpecification"},"description":"Item specifications"},"flags":{"type":"integer","format":"integer","description":"FLAG_NOTE_ACTIVE 1"},"price":{"type":"integer","format":"integer","description":"Item price in cents"},"setupPrice":{"type":"integer","format":"integer","description":"Item setup price in cents"},"priceLinkGroupId":{"type":"integer","format":"integer","description":"Item price is dependent on the price of this group or the entire order.\nIf -1, the price is a percentage (priceLinkPercentage) of the order.\nIf > 0, the price is a percentage (priceLinkPercentage) of the indicated group."},"priceLinkPercentage":{"type":"number","format":"float","description":"The percentage as refered to by priceLinkGroupId description."},"displayOrder":{"type":"integer","format":"integer","description":"Item display order"},"excludeConfigs":{"type":"array","items":{"type":"integer","format":"integer"},"description":"ApplicationInstanceConfiguration IDs from which this item must be excluded."},"excludeLocationIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"Location IDs from which this item must be excluded."}},"additionalProperties":false},"CalcItemSpecification":{"type":"object","required":["id","name","value","dataType","mandatory"],"properties":{"id":{"type":"integer","format":"integer","description":"Item specification ID"},"name":{"type":"string","format":"","description":"Item specification name"},"value":{"type":"string","format":"","description":"Item specification value"},"dataType":{"type":"string","format":"","description":"Item specification data type (int, float, string)"},"mandatory":{"type":"integer","format":"integer","description":"Whether this item specification is mandatory"}},"additionalProperties":false}}}}
```

## The CalcItem object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcItem":{"type":"object","required":["id","code","name","shortName","ident","quantity","specifications","flags","price","setupPrice","priceLinkGroupId","priceLinkPercentage","displayOrder","excludeConfigs","excludeLocationIds"],"properties":{"id":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration item ID"},"code":{"type":"string","format":"","description":"ApplicationInstanceConfiguration item code"},"name":{"type":"string","format":"","description":"Item name"},"shortName":{"type":"string","format":"","description":"Item name short"},"ident":{"type":"string","format":"","description":"Item human readable unique identifier"},"quantity":{"type":"integer","format":"integer","description":"Item quantity"},"specifications":{"type":"array","items":{"$ref":"#/components/schemas/CalcItemSpecification"},"description":"Item specifications"},"flags":{"type":"integer","format":"integer","description":"FLAG_NOTE_ACTIVE 1"},"price":{"type":"integer","format":"integer","description":"Item price in cents"},"setupPrice":{"type":"integer","format":"integer","description":"Item setup price in cents"},"priceLinkGroupId":{"type":"integer","format":"integer","description":"Item price is dependent on the price of this group or the entire order.\nIf -1, the price is a percentage (priceLinkPercentage) of the order.\nIf > 0, the price is a percentage (priceLinkPercentage) of the indicated group."},"priceLinkPercentage":{"type":"number","format":"float","description":"The percentage as refered to by priceLinkGroupId description."},"displayOrder":{"type":"integer","format":"integer","description":"Item display order"},"excludeConfigs":{"type":"array","items":{"type":"integer","format":"integer"},"description":"ApplicationInstanceConfiguration IDs from which this item must be excluded."},"excludeLocationIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"Location IDs from which this item must be excluded."}},"additionalProperties":false},"CalcItemSpecification":{"type":"object","required":["id","name","value","dataType","mandatory"],"properties":{"id":{"type":"integer","format":"integer","description":"Item specification ID"},"name":{"type":"string","format":"","description":"Item specification name"},"value":{"type":"string","format":"","description":"Item specification value"},"dataType":{"type":"string","format":"","description":"Item specification data type (int, float, string)"},"mandatory":{"type":"integer","format":"integer","description":"Whether this item specification is mandatory"}},"additionalProperties":false}}}}
```

## The CalcItemSpecification object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcItemSpecification":{"type":"object","required":["id","name","value","dataType","mandatory"],"properties":{"id":{"type":"integer","format":"integer","description":"Item specification ID"},"name":{"type":"string","format":"","description":"Item specification name"},"value":{"type":"string","format":"","description":"Item specification value"},"dataType":{"type":"string","format":"","description":"Item specification data type (int, float, string)"},"mandatory":{"type":"integer","format":"integer","description":"Whether this item specification is mandatory"}},"additionalProperties":false}}}}
```

## The CalcOrder object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcOrder":{"type":"object","required":["id","finalized","createdAt","modifiedAt","quantity","title","categoryId","categoryName","configTag","configName","configFlags","instantDeliverable","price","setup","vat","vatPercentage","items"],"properties":{"id":{"type":"integer","format":"integer","description":"Order ID"},"finalized":{"type":"boolean","description":"Whether the order has been added to your cart."},"createdAt":{"type":"integer","format":"integer","description":"Order creation unix timestamp"},"modifiedAt":{"type":"integer","format":"integer","description":"Order last modification unix timestamp"},"quantity":{"type":"integer","format":"integer","description":"Order quantity multiplier"},"title":{"type":"string","format":"","description":"Order title"},"categoryId":{"type":"integer","format":"integer","description":"Order shop category ID"},"categoryName":{"type":"string","format":"","description":"Order shop category name"},"configTag":{"type":"string","format":"","description":"The tag of the configuration this order is based upon."},"configName":{"type":"string","format":"","description":"The name of the configuration this order is based upon."},"configFlags":{"type":"integer","format":"integer","description":"ApplicationInstanceConfiguration flags\nIMMUTABLE         1;\nINSTANT_CONFIG    2;\nALLOW_DOWNGRADE   4;\nIS_DEAL           8;\nON_DEAL_PAGE      16;\nCOLO_NO_CONN      32;\nPRIVATE_CONFIG    64;"},"instantDeliverable":{"type":"boolean","description":"Whether this configuration can be setup instantly and automatically (low wait time)"},"price":{"type":"integer","format":"integer","description":"Order price in cents"},"setup":{"type":"integer","format":"integer","description":"Order setup price in cents"},"vat":{"type":"integer","format":"integer","description":"Order VAT in cents"},"vatPercentage":{"type":"number","format":"float","description":"Order VAT percentage"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CalcOrderItem"},"description":"All items and quantities in the order"}},"additionalProperties":false},"CalcOrderItem":{"type":"object","required":["itemId","groupId","quantity"],"properties":{"itemId":{"type":"integer","format":"integer","description":"Item ID"},"groupId":{"type":"integer","format":"integer","description":"Item group ID"},"quantity":{"type":"integer","format":"integer","description":"Item quantity"}},"additionalProperties":false}}}}
```

## The CalcOrderCreate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcOrderCreate":{"type":"object","required":["configTag","couponTag","instantFinalize"],"properties":{"configTag":{"type":"string","format":"","description":"Configuration tag to create an order from."},"couponTag":{"type":"string","format":"","description":"Coupon tag to apply to the order."},"instantFinalize":{"type":"boolean","description":"Whether you want to immediately make the order available for checkout."}},"additionalProperties":false}}}}
```

## The CalcOrderItem object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcOrderItem":{"type":"object","required":["itemId","groupId","quantity"],"properties":{"itemId":{"type":"integer","format":"integer","description":"Item ID"},"groupId":{"type":"integer","format":"integer","description":"Item group ID"},"quantity":{"type":"integer","format":"integer","description":"Item quantity"}},"additionalProperties":false}}}}
```

## The CalcOrderMeta object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcOrderMeta":{"type":"object","required":["id","finalized","instantDeliverable"],"properties":{"id":{"type":"integer","format":"integer","description":"Order ID"},"finalized":{"type":"boolean","description":"True if an order has been added to the cart."},"instantDeliverable":{"type":"boolean","description":"Whether this order is instantly deliverable (normally speaking)"}},"additionalProperties":false}}}}
```

## The CalcOrderQuote object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcOrderQuote":{"type":"object","required":["firstName","lastName","email","phone"],"properties":{"userId":{"type":"integer","format":"integer","description":"Customer's user ID"},"firstName":{"type":"string","minLength":2,"maxLength":64,"format":"","description":"Customer's first name"},"lastName":{"type":"string","minLength":2,"maxLength":128,"format":"","description":"Customer's last name"},"companyName":{"type":"string","maxLength":120,"format":"","description":"Customer's company name (optional)"},"email":{"type":"string","maxLength":128,"format":"","description":"Customer's email address"},"phone":{"type":"string","minLength":5,"maxLength":15,"format":"","description":"Customer's phone number"},"remarks":{"type":"string","maxLength":4000,"format":"","description":"Remarks contain specific question(s) regarding the quote"}},"additionalProperties":false}}}}
```

## The CalcOrderUpdate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcOrderUpdate":{"type":"object","required":["quantity","items"],"properties":{"quantity":{"type":"integer","format":"integer","description":"Order quantity"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CalcOrderItem"},"description":"Order items"}},"additionalProperties":false},"CalcOrderItem":{"type":"object","required":["itemId","groupId","quantity"],"properties":{"itemId":{"type":"integer","format":"integer","description":"Item ID"},"groupId":{"type":"integer","format":"integer","description":"Item group ID"},"quantity":{"type":"integer","format":"integer","description":"Item quantity"}},"additionalProperties":false}}}}
```

## The CalcServiceVatPercentage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CalcServiceVatPercentage":{"type":"object","required":["taxPercent"],"properties":{"taxPercent":{"type":"number","format":"float","description":"VAT percentage"}},"additionalProperties":false}}}}
```

## The CallbackSetting object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CallbackSetting":{"type":"object","required":["id","url"],"properties":{"id":{"type":"integer","format":"integer","description":"Callback setting ID, can be used as callbackSettingId in other endpoints.","readOnly":true},"url":{"type":"string","format":"","description":"This is the url that the system will use when the callback is executed."},"urlDescription":{"type":"string","format":"","description":"Description of the callback setting."},"headers":{"type":"string","format":"","description":"For sending additional meta information about the callback request."}},"additionalProperties":false}}}}
```

## The ColocatedAccess object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedAccess":{"type":"object","required":["id","email","mobile","firstName","lastName","birthDate","companyName"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of colocation access request","readOnly":true},"visitorId":{"type":"integer","format":"integer","description":"The ID of the visitor"},"email":{"type":"string","format":"","description":"The e-mail address of the visitor"},"mobile":{"type":"string","format":"","description":"The mobile phone number of the visitor"},"firstName":{"type":"string","format":"","description":"The first name of the visitor"},"lastName":{"type":"string","format":"","description":"The last name of the visitor"},"birthDate":{"type":"string","format":"","description":"The birth date of the visitor"},"companyName":{"type":"string","format":"","description":"The company name of visitor"},"colocatedAccessServer":{"type":"array","items":{"$ref":"#/components/schemas/ColocatedAccessServer"},"description":"The colocated servers to which access is requested. if this is empty then the visitor get access to all colocated servers of the requester","nullable":true},"temporaryAccess":{"type":"integer","format":"integer","description":"If this field is set to 1, then the visitor has a temporary access","nullable":true},"visitRequester":{"type":"integer","format":"integer","description":"If this field is set to 1, then this visitor can add a temporary access for other visitor","nullable":true},"permanentRequester":{"type":"integer","format":"integer","description":"If this field is set to 1, then this visitor can request a permanent access for other visitor","nullable":true}},"additionalProperties":false},"ColocatedAccessServer":{"type":"object","required":["coloserverId","rackname"],"properties":{"coloserverId":{"type":"integer","format":"integer","description":"The ID of the colocated server where the visitor has access to"},"rackname":{"type":"string","format":"","description":"The name of the rack where the visitor has access to"}},"additionalProperties":false}}}}
```

## The ColocatedAccessDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedAccessDetails":{"type":"object","required":["id","visitorId","email","mobile","firstName","lastName","birthDate","countryEn","accountDocument","createdBy","newEntry","status"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of colocation access request","readOnly":true},"visitorId":{"type":"integer","format":"integer","description":"The ID of the user"},"datacenterId":{"type":"integer","format":"integer","description":"The ID of data center","nullable":true},"dateverified":{"type":"string","format":"","description":"The date when the user was verified","nullable":true},"dateonlist":{"type":"string","format":"","description":"The date when the user was added to the access list","nullable":true},"dateofflist":{"type":"string","format":"","description":"The date when the user was removed from the access list","nullable":true},"email":{"type":"string","format":"","description":"The e-mail address of the visitor"},"mobile":{"type":"string","format":"","description":"The mobile phone number of the visitor"},"firstName":{"type":"string","format":"","description":"The first name of the visitor"},"lastName":{"type":"string","format":"","description":"The last name of the visitor"},"birthDate":{"type":"string","format":"","description":"The birth date of the user. The format is YYYY-MM-DD"},"companyName":{"type":"string","format":"","description":"The company name of the visitor","nullable":true},"city":{"type":"string","format":"","description":"The city of the visitor","nullable":true},"countryEn":{"type":"string","format":"","description":"The country name of the visitor","readOnly":true},"colocatedAccessServers":{"type":"array","items":{"$ref":"#/components/schemas/ColocatedAccessServer"},"description":"The colocated server to which access is requested","nullable":true},"adminNotesReadOnly":{"type":"string","format":"","description":"Notes for admins","nullable":true},"accountDocument":{"type":"array","items":{"$ref":"#/components/schemas/AccountDocument"},"description":"The account document of the user","readOnly":true},"checked":{"type":"string","format":"","description":"Was the user checked?","nullable":true},"createdBy":{"type":"integer","format":"integer","description":"ID of user creator","readOnly":true},"newEntry":{"type":"integer","format":"integer","description":"Is this a new entry","readOnly":true},"temporaryAccess":{"type":"integer","format":"integer","description":"temporaryAccess If this field is set to 1, then has the visitor a temporary access","nullable":true},"fingerPrintId":{"type":"integer","format":"integer","description":"The print ID from Syntegro system","nullable":true},"printMade":{"type":"string","format":"","description":"Was the print made","nullable":true},"visitRequester":{"type":"integer","format":"integer","description":"If this field is set to 1, then this visitor can add a temporary access for other visitor","nullable":true},"permanentRequester":{"type":"integer","format":"integer","description":"If this field is set to 1, then this visitor can request a permanent access for other visitor","nullable":true},"syntegroEmployeeCode":{"type":"string","format":"","description":"The Syntegro employee code of visitor","nullable":true},"status":{"type":"string","format":"","description":"The status of the visitor (granted, pending, denied, revoked, suspended)","readOnly":true}},"additionalProperties":false},"ColocatedAccessServer":{"type":"object","required":["coloserverId","rackname"],"properties":{"coloserverId":{"type":"integer","format":"integer","description":"The ID of the colocated server where the visitor has access to"},"rackname":{"type":"string","format":"","description":"The name of the rack where the visitor has access to"}},"additionalProperties":false},"AccountDocument":{"type":"object","required":["id","documentType","documentNumber","documentExpiration"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the document","readOnly":true},"documentType":{"type":"integer","format":"integer","description":"Type of the document"},"documentNumber":{"type":"string","format":"","description":"Number of document"},"documentExpiration":{"type":"string","format":"","description":"Expiration date of document"}},"additionalProperties":false}}}}
```

## The ColocatedAccessServer object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedAccessServer":{"type":"object","required":["coloserverId","rackname"],"properties":{"coloserverId":{"type":"integer","format":"integer","description":"The ID of the colocated server where the visitor has access to"},"rackname":{"type":"string","format":"","description":"The name of the rack where the visitor has access to"}},"additionalProperties":false}}}}
```

## The ColocatedAlert object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedAlert":{"type":"object","required":["id","percentage","sendMail","sendTicket","triggered","createdAt"],"properties":{"id":{"type":"integer","format":"integer","description":"Colocation alert ID","readOnly":true},"percentage":{"type":"integer","format":"integer","description":"At what percentage of bandwidth usage to trigger the alert"},"sendMail":{"type":"integer","format":"integer","description":"Will send an email notification when alert is triggered"},"sendTicket":{"type":"integer","format":"integer","description":"WIll create a ticket notification when alert is triggered"},"triggered":{"type":"integer","format":"integer","description":"UNIX timestamp of the last time the alert was triggered","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UNIX timestamp of the time the alert was created","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocatedRack object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedRack":{"type":"object","required":["rack","rentedUnits"],"properties":{"rack":{"type":"string","format":"","description":"Suit number and rack number","readOnly":true},"rentedUnits":{"type":"integer","format":"integer","description":"Number of units in colocation service","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocatedServer object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedServer":{"type":"object","required":["id","datacenter","rack","dateStart","dateEnd","dateCancelled","dateEndContract","contractPeriod","extendPeriod","cancellationPeriod","paymentTerm","pricePerMonth","pricePerTbOveruse","currencyId","bandwidthBillingType","bandwidthContractual","trafficSum","trafficSumMonthMbit","outgoingTrafficSum","incomingTrafficSum","powerMaxAmpere","powerKwhPrice","powerMeter","powerSumHistory","network","uplinks","unlimitedIngress"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the colocation service","readOnly":true},"name":{"type":"string","format":"","description":"The name of the colocation service"},"datacenter":{"allOf":[{"$ref":"#/components/schemas/DataCenter"}],"description":"The data center details","readOnly":true},"rack":{"allOf":[{"$ref":"#/components/schemas/ColocatedRack"}],"description":"The rack details in which the server is installed","readOnly":true},"dateStart":{"type":"string","format":"","description":"Contract start date","readOnly":true},"dateEnd":{"type":"string","format":"","description":"The date until which the service is paid","readOnly":true},"dateCancelled":{"type":"string","format":"","description":"Contract cancel date if contract is cancelled","readOnly":true},"dateEndContract":{"type":"string","format":"","description":"Contract end date","readOnly":true},"contractPeriod":{"type":"integer","format":"integer","description":"The duration of the contract in months","readOnly":true},"extendPeriod":{"type":"integer","format":"integer","description":"The extended period of the contract in months","readOnly":true},"cancellationPeriod":{"type":"integer","format":"integer","description":"The cancellation period in months","readOnly":true},"purchaseOrder":{"type":"string","format":"","description":"The order-name to which the server belongs"},"paymentTerm":{"type":"integer","format":"integer","description":"The duration in which the invoice has to be paid after receiving.","readOnly":true},"pricePerMonth":{"type":"string","format":"","description":"The price of this colocated server per month in cents","readOnly":true},"pricePerTbOveruse":{"type":"string","format":"","description":"The price of traffic overuse in cents (per TB) (see `currencyId` for currency)","readOnly":true},"currencyId":{"type":"integer","format":"integer","description":"The currency in which the various 'price' fields are:\n* 0: EURO\n* 1: USD\n* 9: YEN","readOnly":true},"bandwidthBillingType":{"type":"integer","format":"integer","description":"The bandwidth billing method for this service:\n* 1: unmetered connection\n* 2: measured in TB per month\n* 3: measured in mbit 95th percentile","readOnly":true},"bandwidthContractual":{"type":"integer","format":"integer","description":"The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals `2`, in mbit otherwise","readOnly":true},"trafficSum":{"type":"integer","format":"integer","description":"The total used traffic (Mbit or GB, incoming + outgoing)","readOnly":true},"trafficSumMonthMbit":{"type":"integer","format":"integer","description":"The total used traffic (Mbit) for 95th percentile","readOnly":true},"outgoingTrafficSum":{"type":"integer","format":"integer","description":"The outgoing traffic (Mbit or GB)","readOnly":true},"incomingTrafficSum":{"type":"integer","format":"integer","description":"The incoming traffic (Mbit or GB)","readOnly":true},"powerMaxAmpere":{"type":"string","format":"","description":"Contractual maximum usable amperage","readOnly":true},"powerKwhPrice":{"type":"string","format":"","description":"The power price per kWh in cents","readOnly":true},"powerMeter":{"type":"integer","format":"integer","description":"The current power meter(kWh)","readOnly":true},"powerSumHistory":{"type":"array","items":{"$ref":"#/components/schemas/PowerConsumptionPerDay"},"description":"The history of the power usage and the power meter","readOnly":true},"network":{"type":"array","items":{"$ref":"#/components/schemas/Network"},"description":"The network connection specifications","readOnly":true},"uplinks":{"type":"array","items":{"$ref":"#/components/schemas/ColocatedServerUplink"},"description":"The available uplinks for this colocated server","readOnly":true},"unlimitedIngress":{"type":"integer","format":"integer","description":"Does the service have free incoming traffic?","readOnly":true}},"additionalProperties":false},"DataCenter":{"type":"object","required":["address","contact","wifi"],"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/DatacenterAddress"}],"description":"The address of the data center","readOnly":true},"contact":{"allOf":[{"$ref":"#/components/schemas/DatacenterContact"}],"description":"The contact information","readOnly":true},"wifi":{"allOf":[{"$ref":"#/components/schemas/WifiCredential"}],"description":"The wifi credentials","readOnly":true}},"additionalProperties":false},"DatacenterAddress":{"type":"object","required":["name","address","zipCode","city","country"],"properties":{"name":{"type":"string","format":"","description":"The name of the Location","readOnly":true},"address":{"type":"string","format":"","description":"The address of the location","readOnly":true},"zipCode":{"type":"string","format":"","description":"The zip-code of the location","readOnly":true},"city":{"type":"string","format":"","description":"The city name","readOnly":true},"country":{"type":"string","format":"","description":"The country name","readOnly":true}},"additionalProperties":false},"DatacenterContact":{"type":"object","required":["phoneNumber","emergencyPhoneNumber","faxNumber","emailAddress"],"properties":{"phoneNumber":{"type":"string","format":"","description":"The phone-number","readOnly":true},"emergencyPhoneNumber":{"type":"string","format":"","description":"The emergency phone-number","readOnly":true},"faxNumber":{"type":"string","format":"","description":"The fax-number","readOnly":true},"emailAddress":{"type":"string","format":"","description":"The email-address","readOnly":true}},"additionalProperties":false},"WifiCredential":{"type":"object","required":["networkName","userName","password"],"properties":{"networkName":{"type":"string","format":"","description":"Wifi SSID","readOnly":true},"userName":{"type":"string","format":"","description":"Wifi user-name","readOnly":true},"password":{"type":"string","format":"","description":"Wifi Password","readOnly":true}},"additionalProperties":false},"ColocatedRack":{"type":"object","required":["rack","rentedUnits"],"properties":{"rack":{"type":"string","format":"","description":"Suit number and rack number","readOnly":true},"rentedUnits":{"type":"integer","format":"integer","description":"Number of units in colocation service","readOnly":true}},"additionalProperties":false},"PowerConsumptionPerDay":{"type":"object","required":["date","powerMeter","powerUsed"],"properties":{"date":{"type":"string","format":"","description":"The corresponding date","readOnly":true},"powerMeter":{"type":"string","format":"","description":"The power meter(kWh)","readOnly":true},"powerUsed":{"type":"string","format":"","description":"The used power(kWh)","readOnly":true}},"additionalProperties":false},"Network":{"type":"object","required":["vlanId","ipRange","ipRangeCustom"],"properties":{"vlanId":{"type":"integer","format":"integer","description":"The vlan ID","readOnly":true},"ipRange":{"type":"array","items":{"$ref":"#/components/schemas/IpRangeCidr"},"description":"Defines a list of IP ranges with a prefix in CIDR format (such as 123.123.123.64/26)","readOnly":true},"ipRangeCustom":{"type":"array","items":{"$ref":"#/components/schemas/IpRangeCustom"},"description":"Defines a list of custom IP ranges that do not use prefixes but have an arbitrary start and end ip range (such as 123.123.123.100 - 123.123.123.200)","readOnly":true}},"additionalProperties":false},"IpRangeCidr":{"type":"object","required":["network","netmask","prefix","gateway","rDns"],"properties":{"network":{"type":"string","format":"","description":"The ip of the network","readOnly":true},"netmask":{"type":"string","format":"","description":"The range netmask","readOnly":true},"prefix":{"type":"string","format":"","description":"CIDR prefix, including leading slash","readOnly":true},"gateway":{"type":"string","format":"","description":"The gateway IP","readOnly":true},"vrrp1":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"vrrp2":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"rDns":{"type":"array","items":{"$ref":"#/components/schemas/RDns"},"description":"RDNS records","readOnly":true}},"additionalProperties":false},"RDns":{"type":"object","required":["hostname","ip"],"properties":{"hostname":{"type":"string","format":"","description":"The hostname"},"ip":{"type":"string","format":"","description":"The corresponding ip for the host","readOnly":true}},"additionalProperties":false},"IpRangeCustom":{"type":"object","required":["networkStart","networkEnd","gateway","rDns"],"properties":{"networkStart":{"type":"string","format":"","description":"The start ip of the network","readOnly":true},"networkEnd":{"type":"string","format":"","description":"The end ip of the network","readOnly":true},"gateway":{"type":"string","format":"","description":"The gateway IP","readOnly":true},"vrrp1":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"vrrp2":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"rDns":{"type":"array","items":{"$ref":"#/components/schemas/RDns"},"description":"RDNS records","readOnly":true}},"additionalProperties":false},"ColocatedServerUplink":{"type":"object","required":["uplinkId","aggregate"],"properties":{"uplinkId":{"type":"integer","format":"integer","description":"The cacti ID of the uplink","readOnly":true},"aggregate":{"type":"boolean","description":"True if the uplink is an aggregated uplink, false if it is not aggregated","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocatedServerUplink object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocatedServerUplink":{"type":"object","required":["uplinkId","aggregate"],"properties":{"uplinkId":{"type":"integer","format":"integer","description":"The cacti ID of the uplink","readOnly":true},"aggregate":{"type":"boolean","description":"True if the uplink is an aggregated uplink, false if it is not aggregated","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocationNetworkDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocationNetworkDataTelemetry":{"type":"object","required":["timestamp","networkIngress","networkEgress"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"networkIngress":{"type":"integer","format":"integer","description":"The network's ingress in bytes","readOnly":true},"networkEgress":{"type":"integer","format":"integer","description":"The network's egress in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocationNetworkTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocationNetworkTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency (hour by default)","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ColocationNetworkDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"ColocationNetworkDataTelemetry":{"type":"object","required":["timestamp","networkIngress","networkEgress"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"networkIngress":{"type":"integer","format":"integer","description":"The network's ingress in bytes","readOnly":true},"networkEgress":{"type":"integer","format":"integer","description":"The network's egress in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocationOveruseTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocationOveruseTelemetry":{"type":"object","required":["coloId","coloName","orderedBandwidth","usedBandwidth"],"properties":{"coloId":{"type":"integer","format":"integer","description":"The ID of the colocation","readOnly":true},"coloName":{"type":"string","format":"","description":"The name of the colocation","readOnly":true},"orderedBandwidth":{"type":"number","format":"float","description":"Allowed bandwidth of the host","readOnly":true},"usedBandwidth":{"type":"number","format":"float","description":"Used bandwidth of the host","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocationPDUHistoryDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocationPDUHistoryDataTelemetry":{"type":"object","required":["timestamp","amps","volts","kwh","powerMeter"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"amps":{"type":"number","format":"float","description":"The value of amps at that time","readOnly":true},"volts":{"type":"number","format":"float","description":"The value of volts at that time","readOnly":true},"kwh":{"type":"number","format":"float","description":"The value of kwh at that time","readOnly":true},"powerMeter":{"type":"integer","format":"integer","description":"The value of power meter at that time","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocationPDUHistoryTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocationPDUHistoryTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always `null` in this endpoint. This property is there\nfor consistency across all telemetry endpoints. It's `null` because the data is not aggregated","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ColocationPDUHistoryDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"ColocationPDUHistoryDataTelemetry":{"type":"object","required":["timestamp","amps","volts","kwh","powerMeter"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"amps":{"type":"number","format":"float","description":"The value of amps at that time","readOnly":true},"volts":{"type":"number","format":"float","description":"The value of volts at that time","readOnly":true},"kwh":{"type":"number","format":"float","description":"The value of kwh at that time","readOnly":true},"powerMeter":{"type":"integer","format":"integer","description":"The value of power meter at that time","readOnly":true}},"additionalProperties":false}}}}
```

## The ColocationPDUTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ColocationPDUTelemetry":{"type":"object","required":["id","name","kwh"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the colocation service","readOnly":true},"name":{"type":"string","format":"","description":"The name of the colocation service","readOnly":true},"kwh":{"type":"integer","format":"integer","description":"Current month kilo watts per hour","readOnly":true}},"additionalProperties":false}}}}
```

## The Conduit object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Conduit":{"type":"object","required":["conduitName","powerMeter","amperage","peakAmperage"],"properties":{"conduitName":{"type":"string","format":"","description":"The feed name"},"powerMeter":{"type":"integer","format":"integer","description":"The last registered counter value for this outlet"},"amperage":{"type":"number","format":"float","description":"The total amperage supported by the outlet"},"peakAmperage":{"type":"number","format":"float","description":"The peak amperage"}},"additionalProperties":false}}}}
```

## The Country object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Country":{"type":"object","required":["id","code","name","continent"],"properties":{"id":{"type":"integer","format":"integer","description":"The country ID","readOnly":true},"code":{"type":"string","format":"","description":"The country code","readOnly":true},"name":{"type":"string","format":"","description":"The country name","readOnly":true},"continent":{"type":"string","format":"","description":"The continent name","readOnly":true}},"additionalProperties":false}}}}
```

## The CrossConnect object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"CrossConnect":{"type":"object","required":["id","dateStart","dateEnd","dateCancelled","dateEndContract","contractPeriod","extendPeriod","cancellationPeriod","paymentTerm","monthlyFee","setupFee","currencyId","colocatedServerId","hostId","locationIdSideA","locationIdSideAName","locationIdSideZ","locationIdSideZName","locationDetails","rackIdSideA","rackIdSideAName","rackIdSideZ","rackIdSideZName","goLiveDate","internalId","patchInternalName","thirdPartyId","vendorId","cableType","cableSpeed","connectorSideAType","connectorSideZType","diverseFromPatchId","customerNotes","uplinks","connectivityType","outgoingTrafficSum","incomingTrafficSum","bandwidthBillingType"],"properties":{"id":{"type":"integer","format":"integer","description":"Cross connect ID","readOnly":true},"dateStart":{"type":"string","format":"","description":"Start date of the cross connect","readOnly":true},"dateEnd":{"type":"string","format":"","description":"End date of the cross connect","readOnly":true},"dateCancelled":{"type":"string","format":"","description":"Cancelled date of the cross connect","readOnly":true},"dateEndContract":{"type":"string","format":"","description":"End contract date of the cross connect","readOnly":true},"contractPeriod":{"type":"integer","format":"integer","description":"Contract period of the cross connect","readOnly":true},"extendPeriod":{"type":"integer","format":"integer","description":"Extend period of the cross connect","readOnly":true},"cancellationPeriod":{"type":"integer","format":"integer","description":"The cancellation period in months","readOnly":true},"paymentTerm":{"type":"integer","format":"integer","description":"Payment term of the cross connect","readOnly":true},"purchaseOrder":{"type":"string","format":"","description":"Purchase order of the cross connect"},"monthlyFee":{"type":"string","format":"","description":"Monthly fee of the cross connect in cents","readOnly":true},"setupFee":{"type":"string","format":"","description":"Setup fee of the cross connect in cents","readOnly":true},"currencyId":{"type":"integer","format":"integer","description":"The currency ID\n* 0: EURO\n* 1: USD\n* 9: YEN","readOnly":true},"colocatedServerId":{"type":"integer","format":"integer","description":"Colocated server ID","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"Host ID","readOnly":true},"locationIdSideA":{"type":"integer","format":"integer","description":"Location ID of the Side A","readOnly":true},"locationIdSideAName":{"type":"string","format":"","description":"Location name of the Side A","readOnly":true},"locationIdSideZ":{"type":"integer","format":"integer","description":"Location ID of the Side B","readOnly":true},"locationIdSideZName":{"type":"string","format":"","description":"Location name of the Side B","readOnly":true},"locationDetails":{"type":"string","format":"","description":"Location details","readOnly":true},"rackIdSideA":{"type":"integer","format":"integer","description":"Rack ID of the Side A","readOnly":true},"rackIdSideAName":{"type":"string","format":"","description":"Rack Name of the Side A","readOnly":true},"rackIdSideZ":{"type":"integer","format":"integer","description":"Rack ID of the Side B","readOnly":true},"rackIdSideZName":{"type":"string","format":"","description":"Rack Name of the Side B","readOnly":true},"goLiveDate":{"type":"string","format":"","description":"Go live date","readOnly":true},"internalId":{"type":"string","format":"","description":"Internal ID of the service","readOnly":true},"patchInternalName":{"type":"string","format":"","description":"Internal name of the patch","readOnly":true},"patchCustomerName":{"type":"string","format":"","description":"Customer name of the patch"},"thirdPartyId":{"type":"string","format":"","description":"Third party ID of the service","readOnly":true},"vendorId":{"type":"integer","format":"integer","description":"Vendor ID of the service","readOnly":true},"cableType":{"type":"integer","format":"integer","description":"Type of cable","readOnly":true},"cableSpeed":{"type":"integer","format":"integer","description":"Cable speed","readOnly":true},"connectorSideAType":{"type":"integer","format":"integer","description":"Connector of Side A","readOnly":true},"connectorSideZType":{"type":"integer","format":"integer","description":"Connector of Side Z","readOnly":true},"diverseFromPatchId":{"type":"integer","format":"integer","description":"Diverse from patch id","readOnly":true},"customerNotes":{"type":"string","format":"","description":"Notes of the customer","readOnly":true},"uplinks":{"type":"array","items":{"$ref":"#/components/schemas/UpLink"},"description":"The available uplinks for this cross connect","readOnly":true},"connectivityType":{"type":"string","format":"","description":"The type of connectivity service\nFollowing will be possible values:\n* Connectivity: Transport\n* Connectivity: IP connectivity\n* Connectivity: Crossconnect","readOnly":true},"outgoingTrafficSum":{"type":"integer","format":"integer","description":"The outgoing traffic (Mbit or GB - defined by \"bandwidthBillingType\")","readOnly":true},"incomingTrafficSum":{"type":"integer","format":"integer","description":"The incoming traffic (Mbit or GB - defined by \"bandwidthBillingType\")","readOnly":true},"bandwidthBillingType":{"type":"integer","format":"integer","description":"The bandwidth billing method for this service:\n* 1: unmetered connection\n* 2: measured in TB per month\n* 3: measured in mbit 95th percentile","readOnly":true}},"additionalProperties":false},"UpLink":{"type":"object","required":["side","uplinkId"],"properties":{"side":{"type":"string","format":"","description":"Side of the uplink\nFollowing will be possible values for sides uplink:\n* A\n* Z","readOnly":true},"uplinkId":{"type":"integer","format":"integer","description":"Up Link ID","readOnly":true}},"additionalProperties":false}}}}
```

## The Currency object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Currency":{"type":"object","required":["id","name","conversionRateToEuro","decimals"],"properties":{"id":{"type":"integer","format":"integer","description":"Currency ID","readOnly":true},"name":{"type":"string","format":"","description":"Currency Name","readOnly":true},"sign":{"type":"string","format":"","description":"Currency Sign"},"conversionRateToEuro":{"type":"number","format":"float","description":"Exchange rate to Euro","readOnly":true},"decimals":{"type":"integer","format":"integer","description":"Number of decimals","readOnly":true}},"additionalProperties":false}}}}
```

## The DataCenter object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"DataCenter":{"type":"object","required":["address","contact","wifi"],"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/DatacenterAddress"}],"description":"The address of the data center","readOnly":true},"contact":{"allOf":[{"$ref":"#/components/schemas/DatacenterContact"}],"description":"The contact information","readOnly":true},"wifi":{"allOf":[{"$ref":"#/components/schemas/WifiCredential"}],"description":"The wifi credentials","readOnly":true}},"additionalProperties":false},"DatacenterAddress":{"type":"object","required":["name","address","zipCode","city","country"],"properties":{"name":{"type":"string","format":"","description":"The name of the Location","readOnly":true},"address":{"type":"string","format":"","description":"The address of the location","readOnly":true},"zipCode":{"type":"string","format":"","description":"The zip-code of the location","readOnly":true},"city":{"type":"string","format":"","description":"The city name","readOnly":true},"country":{"type":"string","format":"","description":"The country name","readOnly":true}},"additionalProperties":false},"DatacenterContact":{"type":"object","required":["phoneNumber","emergencyPhoneNumber","faxNumber","emailAddress"],"properties":{"phoneNumber":{"type":"string","format":"","description":"The phone-number","readOnly":true},"emergencyPhoneNumber":{"type":"string","format":"","description":"The emergency phone-number","readOnly":true},"faxNumber":{"type":"string","format":"","description":"The fax-number","readOnly":true},"emailAddress":{"type":"string","format":"","description":"The email-address","readOnly":true}},"additionalProperties":false},"WifiCredential":{"type":"object","required":["networkName","userName","password"],"properties":{"networkName":{"type":"string","format":"","description":"Wifi SSID","readOnly":true},"userName":{"type":"string","format":"","description":"Wifi user-name","readOnly":true},"password":{"type":"string","format":"","description":"Wifi Password","readOnly":true}},"additionalProperties":false}}}}
```

## The DatacenterAddress object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"DatacenterAddress":{"type":"object","required":["name","address","zipCode","city","country"],"properties":{"name":{"type":"string","format":"","description":"The name of the Location","readOnly":true},"address":{"type":"string","format":"","description":"The address of the location","readOnly":true},"zipCode":{"type":"string","format":"","description":"The zip-code of the location","readOnly":true},"city":{"type":"string","format":"","description":"The city name","readOnly":true},"country":{"type":"string","format":"","description":"The country name","readOnly":true}},"additionalProperties":false}}}}
```

## The DatacenterContact object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"DatacenterContact":{"type":"object","required":["phoneNumber","emergencyPhoneNumber","faxNumber","emailAddress"],"properties":{"phoneNumber":{"type":"string","format":"","description":"The phone-number","readOnly":true},"emergencyPhoneNumber":{"type":"string","format":"","description":"The emergency phone-number","readOnly":true},"faxNumber":{"type":"string","format":"","description":"The fax-number","readOnly":true},"emailAddress":{"type":"string","format":"","description":"The email-address","readOnly":true}},"additionalProperties":false}}}}
```

## The EmailChange object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"EmailChange":{"type":"object","required":["emailAddress","password"],"properties":{"emailAddress":{"type":"string","format":"","description":"New email address"},"password":{"type":"string","format":"","description":"Password of the user account"}},"additionalProperties":false}}}}
```

## The EmailConfirmation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"EmailConfirmation":{"type":"object","required":["userId","hash"],"properties":{"userId":{"type":"integer","format":"integer","description":"UserId"},"hash":{"type":"string","format":"","description":"Hash"}},"additionalProperties":false}}}}
```

## The EmailConfirmationResend object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"EmailConfirmationResend":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"","description":"Email to resend the confirmation for"}},"additionalProperties":false}}}}
```

## The EmailConfirmationResult object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"EmailConfirmationResult":{"type":"object","required":["emailAddress","emailType"],"properties":{"emailAddress":{"type":"string","format":"","description":"The e-mail address that was validated"},"emailType":{"type":"string","format":"","description":"Type of e-mail that was validated, possible types can be main, billing or abuse"}},"additionalProperties":false}}}}
```

## The Error object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Error":{"type":"object","required":["errorCode","errorMessage","errors"],"properties":{"errorCode":{"type":"integer","format":"integer","description":"Error code"},"errorMessage":{"type":"string","format":"","description":"Error message"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"},"description":"Error details"}},"additionalProperties":false},"ErrorDetails":{"type":"object","required":["property","message"],"properties":{"property":{"type":"string","format":"","description":"Property in which there is an error"},"message":{"type":"string","format":"","description":"Error message"}},"additionalProperties":false}}}}
```

## The ErrorDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"ErrorDetails":{"type":"object","required":["property","message"],"properties":{"property":{"type":"string","format":"","description":"Property in which there is an error"},"message":{"type":"string","format":"","description":"Error message"}},"additionalProperties":false}}}}
```

## The FeatureModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FeatureModel":{"type":"object","required":["geometry","properties"],"properties":{"geometry":{"$ref":"#/components/schemas/GeometryModel"},"properties":{"$ref":"#/components/schemas/PropertiesModel"}},"additionalProperties":false},"GeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":"","description":"The type of the geometry"},"coordinates":{"type":"array","items":{"type":"number","format":"float"},"description":"The geographic coordinates"}},"additionalProperties":false},"PropertiesModel":{"type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"integer","description":"The heat value for the coordinate"}},"additionalProperties":false}}}}
```

## The FlexMetalCapacityCommit object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalCapacityCommit":{"type":"object","required":["location","commits"],"properties":{"location":{"allOf":[{"$ref":"#/components/schemas/FlexMetalLocation"}],"description":"Data center location","readOnly":true},"commits":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalInstanceTypeCommit"},"description":"Committed capacity per instance type","readOnly":true}},"additionalProperties":false},"FlexMetalLocation":{"type":"object","required":["id","name","shortName","displayName","countryId","countryName","countryShortName"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the location","readOnly":true},"name":{"type":"string","format":"","description":"Name of the location","readOnly":true},"shortName":{"type":"string","format":"","description":"Short name of the location","readOnly":true},"displayName":{"type":"string","format":"","description":"Display name of the location","readOnly":true},"countryId":{"type":"integer","format":"integer","description":"Country ID of the location","readOnly":true},"countryName":{"type":"string","format":"","description":"Country name of the Location","readOnly":true},"countryShortName":{"type":"string","format":"","description":"Country short name of the Location","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceTypeCommit":{"type":"object","required":["instanceType","capacity","inUse"],"properties":{"instanceType":{"allOf":[{"$ref":"#/components/schemas/FlexMetalInstanceType"}],"description":"Instance type","readOnly":true},"capacity":{"type":"integer","format":"integer","description":"Total commit of this instance type","readOnly":true},"inUse":{"type":"integer","format":"integer","description":"Instances in use","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceType":{"type":"object","required":["id","locationId","name","sockets","cores","memory","memoryType","storage","storageType","generationName"],"properties":{"id":{"type":"integer","format":"integer","description":"Id of instance type","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"LocationId of instance type","readOnly":true},"name":{"type":"string","format":"","description":"Name of instance type","readOnly":true},"sockets":{"type":"integer","format":"integer","description":"Sockets of instance type","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Cores of instance type","readOnly":true},"memory":{"type":"integer","format":"integer","description":"Memory of instance type","readOnly":true},"memoryType":{"type":"string","format":"","description":"Memory type of instance type","readOnly":true},"storage":{"type":"integer","format":"integer","description":"Storage of instance type","readOnly":true},"storageType":{"type":"string","format":"","description":"Storage type of instance type","readOnly":true},"generationName":{"type":"string","format":"","description":"Generation name of instance type","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalInstanceType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalInstanceType":{"type":"object","required":["id","locationId","name","sockets","cores","memory","memoryType","storage","storageType","generationName"],"properties":{"id":{"type":"integer","format":"integer","description":"Id of instance type","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"LocationId of instance type","readOnly":true},"name":{"type":"string","format":"","description":"Name of instance type","readOnly":true},"sockets":{"type":"integer","format":"integer","description":"Sockets of instance type","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Cores of instance type","readOnly":true},"memory":{"type":"integer","format":"integer","description":"Memory of instance type","readOnly":true},"memoryType":{"type":"string","format":"","description":"Memory type of instance type","readOnly":true},"storage":{"type":"integer","format":"integer","description":"Storage of instance type","readOnly":true},"storageType":{"type":"string","format":"","description":"Storage type of instance type","readOnly":true},"generationName":{"type":"string","format":"","description":"Generation name of instance type","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalInstanceTypeCommit object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalInstanceTypeCommit":{"type":"object","required":["instanceType","capacity","inUse"],"properties":{"instanceType":{"allOf":[{"$ref":"#/components/schemas/FlexMetalInstanceType"}],"description":"Instance type","readOnly":true},"capacity":{"type":"integer","format":"integer","description":"Total commit of this instance type","readOnly":true},"inUse":{"type":"integer","format":"integer","description":"Instances in use","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceType":{"type":"object","required":["id","locationId","name","sockets","cores","memory","memoryType","storage","storageType","generationName"],"properties":{"id":{"type":"integer","format":"integer","description":"Id of instance type","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"LocationId of instance type","readOnly":true},"name":{"type":"string","format":"","description":"Name of instance type","readOnly":true},"sockets":{"type":"integer","format":"integer","description":"Sockets of instance type","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Cores of instance type","readOnly":true},"memory":{"type":"integer","format":"integer","description":"Memory of instance type","readOnly":true},"memoryType":{"type":"string","format":"","description":"Memory type of instance type","readOnly":true},"storage":{"type":"integer","format":"integer","description":"Storage of instance type","readOnly":true},"storageType":{"type":"string","format":"","description":"Storage type of instance type","readOnly":true},"generationName":{"type":"string","format":"","description":"Generation name of instance type","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalInstanceTypePartial object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalInstanceTypePartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"Instance type ID","readOnly":true},"name":{"type":"string","format":"","description":"Instance type name","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalKernelParam object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalKernelParam":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Key of the kernel param"},"value":{"type":"string","format":"","description":"Value of the kernel param"}},"additionalProperties":false}}}}
```

## The FlexMetalLocation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalLocation":{"type":"object","required":["id","name","shortName","displayName","countryId","countryName","countryShortName"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the location","readOnly":true},"name":{"type":"string","format":"","description":"Name of the location","readOnly":true},"shortName":{"type":"string","format":"","description":"Short name of the location","readOnly":true},"displayName":{"type":"string","format":"","description":"Display name of the location","readOnly":true},"countryId":{"type":"integer","format":"integer","description":"Country ID of the location","readOnly":true},"countryName":{"type":"string","format":"","description":"Country name of the Location","readOnly":true},"countryShortName":{"type":"string","format":"","description":"Country short name of the Location","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalLocationPartial object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalLocationPartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the location","readOnly":true},"name":{"type":"string","format":"","description":"Name of the location","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalOperatingSystemRequest object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalOperatingSystemRequest":{"type":"object","required":["slug"],"properties":{"slug":{"type":"string","format":"","description":"Identifier of the OS. Available operating systems can be obtained from /v3/operatingsystem. Use the `slug` field from the response."},"kernelParams":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalKernelParam"},"description":"Kernel params for the PXE stage of the OS installation. Most operating systems do not require these, but e.g. Talos does."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalPartition"},"description":"Custom partitions for the OS installation. If not provided, the default partitioning scheme will be used."},"ipxeScriptUrl":{"type":"string","format":"","description":"The URL to your custom iPXE boot menu file. Can and must be used in combination with OS slug custom-ipxe."}},"additionalProperties":false},"FlexMetalKernelParam":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Key of the kernel param"},"value":{"type":"string","format":"","description":"Value of the kernel param"}},"additionalProperties":false},"FlexMetalPartition":{"type":"object","required":["target","filesystem","size"],"properties":{"target":{"type":"string","format":"","description":"Mount point for the partition"},"filesystem":{"type":"string","format":"","description":"Type of filesystem to use for the target. Allowed: ext2, ext3, ext4, xfs"},"size":{"type":"integer","format":"integer","description":"The size of the partition, in MB. Use -1 to indicate usage of the remaining space on the disk."}},"additionalProperties":false}}}}
```

## The FlexMetalOperatingSystemResponse object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalOperatingSystemResponse":{"type":"object","required":["slug"],"properties":{"slug":{"type":"string","format":"","description":"Identifier of the OS. Available operating systems can be obtained from /v3/operatingsystem. Use the `slug` field from the response."}},"additionalProperties":false}}}}
```

## The FlexMetalPartition object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalPartition":{"type":"object","required":["target","filesystem","size"],"properties":{"target":{"type":"string","format":"","description":"Mount point for the partition"},"filesystem":{"type":"string","format":"","description":"Type of filesystem to use for the target. Allowed: ext2, ext3, ext4, xfs"},"size":{"type":"integer","format":"integer","description":"The size of the partition, in MB. Use -1 to indicate usage of the remaining space on the disk."}},"additionalProperties":false}}}}
```

## The FlexMetalQuotaUsage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalQuotaUsage":{"type":"object","required":["instanceType","quotaType","contractId","quota","usage"],"properties":{"instanceType":{"allOf":[{"$ref":"#/components/schemas/FlexMetalInstanceTypePartial"}],"description":"Instance type","readOnly":true},"quotaType":{"type":"string","format":"","description":"The type of quota. Can be \"onDemand\" or \"commit\".","readOnly":true},"contractId":{"type":"string","format":"","description":"The contract identifier of commited resources. Empty for generic quota."},"quota":{"type":"integer","format":"integer","description":"The assigned quota number of server resources, for this location and instance type.","readOnly":true},"usage":{"type":"integer","format":"integer","description":"The current usage of server resources, for this location and instance type.","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceTypePartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"Instance type ID","readOnly":true},"name":{"type":"string","format":"","description":"Instance type name","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalServer object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalServer":{"type":"object","required":["uuid","name","status","statusMessage","location","instanceType","os","ipAddresses","tags","createdAt","deliveredAt","releasedAt","contractId"],"properties":{"uuid":{"type":"string","format":"","description":"Server UUID.","readOnly":true},"name":{"type":"string","format":"","description":"Server host name."},"status":{"type":"string","format":"","description":"Server delivery status.<br /><li><ul>created</ul><ul>discovering</ul><ul>discovered</ul><ul>allocating</ul><ul>allocated</ul><ul>configuring_network</ul><ul>network_configured</ul><ul>provisioning</ul><ul>provisioned</ul><ul>delivered</ul><ul>failed</ul><ul>releasing</ul><ul>released</ul></li>","readOnly":true},"statusMessage":{"type":"string","format":"","description":"Status message.","readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/FlexMetalLocationPartial"}],"description":"Server location.","readOnly":true},"instanceType":{"allOf":[{"$ref":"#/components/schemas/FlexMetalInstanceTypePartial"}],"description":"Server instance type.","readOnly":true},"os":{"allOf":[{"$ref":"#/components/schemas/FlexMetalOperatingSystemResponse"}],"description":"Server operating system.","readOnly":true},"ipAddresses":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalServerIpAddress"},"description":"Server IP address details.","readOnly":true},"tags":{"type":"array","items":{"type":"string","format":""},"description":"Server tags.","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Server creation timestamp.","readOnly":true},"deliveredAt":{"type":"integer","format":"integer","description":"Server delivery timestamp.","readOnly":true},"releasedAt":{"type":"integer","format":"integer","description":"Server release timestamp.","readOnly":true},"contractId":{"type":"string","format":"","description":"Represents client contractId.","readOnly":true}},"additionalProperties":false},"FlexMetalLocationPartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the location","readOnly":true},"name":{"type":"string","format":"","description":"Name of the location","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceTypePartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"Instance type ID","readOnly":true},"name":{"type":"string","format":"","description":"Instance type name","readOnly":true}},"additionalProperties":false},"FlexMetalOperatingSystemResponse":{"type":"object","required":["slug"],"properties":{"slug":{"type":"string","format":"","description":"Identifier of the OS. Available operating systems can be obtained from /v3/operatingsystem. Use the `slug` field from the response."}},"additionalProperties":false},"FlexMetalServerIpAddress":{"type":"object","required":["ipAddress"],"properties":{"ipAddress":{"type":"string","format":"","description":"Server IP address.","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalServerIpAddress object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalServerIpAddress":{"type":"object","required":["ipAddress"],"properties":{"ipAddress":{"type":"string","format":"","description":"Server IP address.","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalServerQuotaUsage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalServerQuotaUsage":{"type":"object","required":["location","quotaUsage"],"properties":{"location":{"allOf":[{"$ref":"#/components/schemas/FlexMetalLocationPartial"}],"description":"Data center location","readOnly":true},"quotaUsage":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalQuotaUsage"},"description":"Quota and usage for a resource type","readOnly":true}},"additionalProperties":false},"FlexMetalLocationPartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the location","readOnly":true},"name":{"type":"string","format":"","description":"Name of the location","readOnly":true}},"additionalProperties":false},"FlexMetalQuotaUsage":{"type":"object","required":["instanceType","quotaType","contractId","quota","usage"],"properties":{"instanceType":{"allOf":[{"$ref":"#/components/schemas/FlexMetalInstanceTypePartial"}],"description":"Instance type","readOnly":true},"quotaType":{"type":"string","format":"","description":"The type of quota. Can be \"onDemand\" or \"commit\".","readOnly":true},"contractId":{"type":"string","format":"","description":"The contract identifier of commited resources. Empty for generic quota."},"quota":{"type":"integer","format":"integer","description":"The assigned quota number of server resources, for this location and instance type.","readOnly":true},"usage":{"type":"integer","format":"integer","description":"The current usage of server resources, for this location and instance type.","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceTypePartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"Instance type ID","readOnly":true},"name":{"type":"string","format":"","description":"Instance type name","readOnly":true}},"additionalProperties":false}}}}
```

## The FlexMetalServerRequest object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalServerRequest":{"type":"object","required":["name","location","instanceType","os","sshKey"],"properties":{"name":{"type":"string","format":"","description":"Server name or hostname, depending on the chosen OS. E.g. Talos requires a hostname but regular Linux OSs work with either."},"location":{"type":"string","format":"","description":"Server location. Available locations can be obtained from /v3/flexMetal/location. Use the `name` field from the response."},"instanceType":{"type":"string","format":"","description":"Server instance type. Available instance types can be obtained from /v3/flexMetal/location/{locationId}}/instanceTypes. Use the `name` field from the response."},"os":{"allOf":[{"$ref":"#/components/schemas/FlexMetalOperatingSystemRequest"}],"description":"Server operating system."},"sshKey":{"type":"array","items":{"type":"string","format":""},"description":"A list of SSH keys. You can either supply SSH key UUIDs from stored objects in /v3/sshKey or provide public keys directly. SSH keys are installed for the root user."},"postInstallScript":{"type":"string","format":"","description":"Post install script. A shell script (e.g. bash) that will be executed after your OS is installed. Currently only supported for Linux based operating systems."},"tags":{"type":"array","items":{"type":"string","format":""},"description":"A list of tags. There is a maximum of 60 tags per server. Each tag must adhere to this pattern: ^[A-Za-z0-9_:-]{1,64}$"},"contractId":{"type":"string","format":"","description":"Represents client contractId. Format is ^[A-Z0-9_\\-.]{0,240}$"},"overflow":{"type":"boolean","description":"If true, the server will be created even if the location is at commited capacity. Default is false."}},"additionalProperties":false,"description":"Request object for creating a new Flex Metal server"},"FlexMetalOperatingSystemRequest":{"type":"object","required":["slug"],"properties":{"slug":{"type":"string","format":"","description":"Identifier of the OS. Available operating systems can be obtained from /v3/operatingsystem. Use the `slug` field from the response."},"kernelParams":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalKernelParam"},"description":"Kernel params for the PXE stage of the OS installation. Most operating systems do not require these, but e.g. Talos does."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalPartition"},"description":"Custom partitions for the OS installation. If not provided, the default partitioning scheme will be used."},"ipxeScriptUrl":{"type":"string","format":"","description":"The URL to your custom iPXE boot menu file. Can and must be used in combination with OS slug custom-ipxe."}},"additionalProperties":false},"FlexMetalKernelParam":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Key of the kernel param"},"value":{"type":"string","format":"","description":"Value of the kernel param"}},"additionalProperties":false},"FlexMetalPartition":{"type":"object","required":["target","filesystem","size"],"properties":{"target":{"type":"string","format":"","description":"Mount point for the partition"},"filesystem":{"type":"string","format":"","description":"Type of filesystem to use for the target. Allowed: ext2, ext3, ext4, xfs"},"size":{"type":"integer","format":"integer","description":"The size of the partition, in MB. Use -1 to indicate usage of the remaining space on the disk."}},"additionalProperties":false}}}}
```

## The FlexMetalServerRootPassword object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalServerRootPassword":{"type":"object","required":["rootPassword"],"properties":{"rootPassword":{"type":"string","format":"","description":"Server root password."}},"additionalProperties":false}}}}
```

## The FlexMetalTag object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalTag":{"type":"object","required":["tag","resources"],"properties":{"tag":{"type":"string","format":"","description":"The tag name"},"resources":{"allOf":[{"$ref":"#/components/schemas/FlexMetalTagSummary"}],"description":"A list of resources that use this tag","readOnly":true}},"additionalProperties":false,"description":"A Flex Metal tag"},"FlexMetalTagSummary":{"type":"object","required":["count","flexMetalServers"],"properties":{"count":{"type":"integer","format":"integer","description":"The total number of resources that use this tag"},"flexMetalServers":{"allOf":[{"$ref":"#/components/schemas/FlexMetalTagResourceUsage"}],"description":"A summary of tag usage for the FlexMetalServer resource type"}},"additionalProperties":false,"description":"A Flex Metal tag"},"FlexMetalTagResourceUsage":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"integer","description":"The amount of resources of this type that use this tag."}},"additionalProperties":false,"description":"Tag resource usage"}}}}
```

## The FlexMetalTagResourceUsage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalTagResourceUsage":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"integer","description":"The amount of resources of this type that use this tag."}},"additionalProperties":false,"description":"Tag resource usage"}}}}
```

## The FlexMetalTagSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalTagSummary":{"type":"object","required":["count","flexMetalServers"],"properties":{"count":{"type":"integer","format":"integer","description":"The total number of resources that use this tag"},"flexMetalServers":{"allOf":[{"$ref":"#/components/schemas/FlexMetalTagResourceUsage"}],"description":"A summary of tag usage for the FlexMetalServer resource type"}},"additionalProperties":false,"description":"A Flex Metal tag"},"FlexMetalTagResourceUsage":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"integer","description":"The amount of resources of this type that use this tag."}},"additionalProperties":false,"description":"Tag resource usage"}}}}
```

## The FlexMetalUsage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"FlexMetalUsage":{"type":"object","required":["server","startedAt","endedAt","totalHours","totalMinutes","bandwidthIn"],"properties":{"server":{"allOf":[{"$ref":"#/components/schemas/FlexMetalServer"}],"description":"FlexMetal server."},"startedAt":{"type":"string","format":"date-time","description":"Usage tracking starts."},"endedAt":{"type":"string","format":"date-time","description":"Usage tracking ends."},"totalHours":{"type":"integer","format":"integer","description":"Total hours of usage."},"totalMinutes":{"type":"integer","format":"integer","description":"Total minutes of usage."},"bandwidthIn":{"type":"integer","format":"integer","description":"Total bandwidth out."}},"additionalProperties":false},"FlexMetalServer":{"type":"object","required":["uuid","name","status","statusMessage","location","instanceType","os","ipAddresses","tags","createdAt","deliveredAt","releasedAt","contractId"],"properties":{"uuid":{"type":"string","format":"","description":"Server UUID.","readOnly":true},"name":{"type":"string","format":"","description":"Server host name."},"status":{"type":"string","format":"","description":"Server delivery status.<br /><li><ul>created</ul><ul>discovering</ul><ul>discovered</ul><ul>allocating</ul><ul>allocated</ul><ul>configuring_network</ul><ul>network_configured</ul><ul>provisioning</ul><ul>provisioned</ul><ul>delivered</ul><ul>failed</ul><ul>releasing</ul><ul>released</ul></li>","readOnly":true},"statusMessage":{"type":"string","format":"","description":"Status message.","readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/FlexMetalLocationPartial"}],"description":"Server location.","readOnly":true},"instanceType":{"allOf":[{"$ref":"#/components/schemas/FlexMetalInstanceTypePartial"}],"description":"Server instance type.","readOnly":true},"os":{"allOf":[{"$ref":"#/components/schemas/FlexMetalOperatingSystemResponse"}],"description":"Server operating system.","readOnly":true},"ipAddresses":{"type":"array","items":{"$ref":"#/components/schemas/FlexMetalServerIpAddress"},"description":"Server IP address details.","readOnly":true},"tags":{"type":"array","items":{"type":"string","format":""},"description":"Server tags.","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Server creation timestamp.","readOnly":true},"deliveredAt":{"type":"integer","format":"integer","description":"Server delivery timestamp.","readOnly":true},"releasedAt":{"type":"integer","format":"integer","description":"Server release timestamp.","readOnly":true},"contractId":{"type":"string","format":"","description":"Represents client contractId.","readOnly":true}},"additionalProperties":false},"FlexMetalLocationPartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the location","readOnly":true},"name":{"type":"string","format":"","description":"Name of the location","readOnly":true}},"additionalProperties":false},"FlexMetalInstanceTypePartial":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"Instance type ID","readOnly":true},"name":{"type":"string","format":"","description":"Instance type name","readOnly":true}},"additionalProperties":false},"FlexMetalOperatingSystemResponse":{"type":"object","required":["slug"],"properties":{"slug":{"type":"string","format":"","description":"Identifier of the OS. Available operating systems can be obtained from /v3/operatingsystem. Use the `slug` field from the response."}},"additionalProperties":false},"FlexMetalServerIpAddress":{"type":"object","required":["ipAddress"],"properties":{"ipAddress":{"type":"string","format":"","description":"Server IP address.","readOnly":true}},"additionalProperties":false}}}}
```

## The GeometryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"GeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":"","description":"The type of the geometry"},"coordinates":{"type":"array","items":{"type":"number","format":"float"},"description":"The geographic coordinates"}},"additionalProperties":false}}}}
```

## The Health object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Health":{"type":"object","required":["status"],"properties":{"status":{"type":"string","format":"","description":"Status - either OK or FAIL"}},"additionalProperties":false}}}}
```

## The Host object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Host":{"type":"object","required":["id","userId","serverId","serverName","serverType","liveHostName","isVirtual","category","osId","locationId","dcLocationId","instanceType","fleetId","newFleetId","fleetAssociatedSince","rackName","dateStart","dateEnd","dateCancelled","dateEndContract","contractPeriod","extendPeriod","cancellationPeriod","purchaseOrder","paymentTerm","pricePerMonth","pricePerTbOveruse","currencyId","bandwidthBillingType","bandwidthContractual","ipAddress","brand","model","numCpu","cpuInfo","cpuType","cpuLoad","cpu","memUsed","memMax","memFree","disk","memory","isReserve","serviceTag","isODP","fmOrderId","installStatus","status","trafficSum","uplinks","freeIncomingTraffic","outgoingTrafficSum","incomingTrafficSum"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this host","readOnly":true},"userId":{"type":"integer","format":"integer","description":"The ID of the user who owns this server","readOnly":true},"serverId":{"type":"integer","format":"integer","description":"The ID of the physical machine","readOnly":true},"serverName":{"type":"string","format":"","description":"The name of the physical machine","readOnly":true},"serverType":{"type":"integer","format":"integer","description":"The type of the server:\n* 1: Bare metal server\n* 2: Flex metal server\n* 3: Virtual machine","readOnly":true},"projectName":{"type":"string","format":"","description":"The name of the project for the host"},"clientServerName":{"type":"string","format":"","description":"The name of the server defined by client"},"clientState":{"type":"string","format":"","description":"Client statement for the host"},"liveHostName":{"type":"string","format":"","description":"The host name","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this is a bare metal server, 1 if it's a VM. Use `serverType` instead","readOnly":true,"deprecated":true},"category":{"type":"string","format":"","description":"Host category. Normally \"Dedicated Game Servers\" or \"Dedicated Servers\", but can be \"Broken\" if the server is in a degraded state","readOnly":true},"osId":{"type":"integer","format":"integer","description":"Operating system ID, must be one of [`GET /v3/operatingsystem`](all#/OperatingSystem/getOperatingsystems)","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"Legacy location ID (not used for ODP)","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","description":"Datacenter location ID. Points to one of [`GET /v3/cloud/dcLocation`](#/Cloud/getCloudDcLocations)","readOnly":true},"instanceType":{"type":"string","format":"","description":"The instance type of this server, which is one of [`GET /v3/host/instanceType`](#/Host/getHostInstanceTypes) for a bare metal, or one of\n[`GET /v3/cloud/instanceType`](#/Cloud/getCloudInstanceTypes) for a virtual machine","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID, if this host has been assigned to a fleet\nIf `0`, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.","readOnly":true},"newFleetId":{"type":"string","format":"","description":"The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at [`POST /v3/fleet/host/bulkReserve`](#/Fleet/createFleetHostBulkReserve)","nullable":true,"readOnly":true},"fleetAssociatedSince":{"type":"integer","format":"integer","description":"Unix timestamp when fleet assigned to the host","readOnly":true},"rackName":{"type":"string","format":"","description":"The name of the rack the host is located","readOnly":true},"dateStart":{"type":"string","format":"","description":"The date at which this host became active","readOnly":true},"dateEnd":{"type":"string","format":"","description":"The date at which this host will expire","readOnly":true},"dateCancelled":{"type":"string","format":"","description":"The date at which this host was cancelled","readOnly":true},"dateEndContract":{"type":"string","format":"","description":"The date at which the contract ends (if applicable)","readOnly":true},"contractPeriod":{"type":"integer","format":"integer","description":"The contract period in months","readOnly":true},"extendPeriod":{"type":"integer","format":"integer","description":"The service extend period in months","readOnly":true},"cancellationPeriod":{"type":"integer","format":"integer","description":"The cancellation period in months","readOnly":true},"purchaseOrder":{"type":"string","format":"","description":"Purchase order, if one has been supplied via our billing department","readOnly":true},"paymentTerm":{"type":"integer","format":"integer","description":"The payment term in days (how many days are invoices generated before dateEnd)","readOnly":true},"pricePerMonth":{"type":"string","format":"","description":"The price of this host per month in cents (see `currencyId` for currency)","readOnly":true},"pricePerTbOveruse":{"type":"string","format":"","description":"The price of traffic overuse in cents (per TB) (see `currencyId` for currency)","readOnly":true},"currencyId":{"type":"integer","format":"integer","description":"The currency of the `pricePerMonth` field:\n* 0: EURO\n* 1: USD\n* 9: YEN","readOnly":true},"bandwidthBillingType":{"type":"integer","format":"integer","description":"The bandwidth billing method for this service:\n* 1: unmetered connection\n* 2: measured in TB per month\n* 3: measured in mbit 95th percentile","readOnly":true},"bandwidthContractual":{"type":"integer","format":"integer","description":"The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals `2`, in mbit otherwise","readOnly":true},"ipAddress":{"type":"array","items":{"$ref":"#/components/schemas/HostIP"},"description":"All IP addresses assigned to this host","readOnly":true},"brand":{"type":"string","format":"","description":"The server manufacturer brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model of the server","readOnly":true},"numCpu":{"type":"integer","format":"integer","description":"Number of CPUs in this host","readOnly":true},"cpuInfo":{"type":"string","format":"","readOnly":true},"cpuType":{"type":"string","format":"","readOnly":true},"cpuLoad":{"type":"number","format":"float","description":"Percentage of cpu used across all cores","readOnly":true},"cpu":{"allOf":[{"$ref":"#/components/schemas/HostCpu"}],"readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the host (in megabytes)","readOnly":true},"memMax":{"type":"integer","format":"integer","description":"The amount of memory that is available on the host (in megabytes)","readOnly":true},"memFree":{"type":"integer","format":"integer","description":"The amount of free memory that is available on the host (in megabytes)","readOnly":true},"disk":{"type":"array","items":{"$ref":"#/components/schemas/HostDisk"},"readOnly":true},"memory":{"type":"array","items":{"$ref":"#/components/schemas/HostMemory"},"readOnly":true},"isReserve":{"type":"integer","format":"integer","description":"If the host is reserved for a fleet isReserve set to 1","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Custom key/value pairs that can be used for host"},"serviceTag":{"type":"string","format":"","description":"The service tag of the host","readOnly":true},"isODP":{"type":"integer","format":"integer","description":"If the host is available for game hosting platform isODP set to 1","readOnly":true},"fmOrderId":{"type":"string","format":"","description":"ID of Flex Metal order if this is a flex metal server","nullable":true,"readOnly":true},"installStatus":{"type":"string","format":"","description":"Status of server auto install if it was started by one. (created / installing / finished / failed)","nullable":true,"readOnly":true},"status":{"type":"string","format":"","description":"Whether the host is running or not","readOnly":true},"uptime":{"type":"integer","format":"integer","description":"The uptime of the host. Read-only. Only provided if the server checked-in recently"},"trafficSum":{"type":"integer","format":"integer","description":"Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration","readOnly":true},"uplinks":{"type":"array","items":{"$ref":"#/components/schemas/HostUplink"},"description":"A list of uplinks attached to this host","readOnly":true},"freeIncomingTraffic":{"type":"boolean","description":"Whether the host has free incoming traffic or not","readOnly":true},"outgoingTrafficSum":{"type":"integer","format":"integer","description":"The outgoing traffic (Mbit or GB)","readOnly":true},"incomingTrafficSum":{"type":"integer","format":"integer","description":"The incoming traffic (Mbit or GB)","readOnly":true}},"additionalProperties":false},"HostIP":{"type":"object","required":["ipAddress","version","type","private","interface","macAddress","rDns","vlanId","gateway","netmask","prefix"],"properties":{"ipAddress":{"type":"string","format":"","description":"Host IP address","readOnly":true},"version":{"type":"integer","format":"integer","description":"IP version, possible values can be 4 or 6","readOnly":true},"type":{"type":"integer","format":"integer","description":"IP type:\n1) normal,\n2) KVM,\n253) VRRP1,\n254) VRRP2,\n255) gateway","readOnly":true},"private":{"type":"integer","format":"integer","description":"Private IP (1) or public IP (0)","readOnly":true},"interface":{"type":"integer","format":"integer","description":"ID of the interface (0-7)","readOnly":true},"macAddress":{"type":"string","format":"","description":"MAC address of the interface","readOnly":true},"rDns":{"type":"string","format":"","description":"RDNS of the interface","readOnly":true},"vlanId":{"type":"integer","format":"integer","description":"ID for the VLAN","nullable":true,"readOnly":true},"gateway":{"type":"string","format":"","description":"Interface gateway","nullable":true,"readOnly":true},"netmask":{"type":"string","format":"","description":"Interface netmask","nullable":true,"readOnly":true},"prefix":{"type":"integer","format":"integer","description":"Interface prefix","nullable":true,"readOnly":true}},"additionalProperties":false},"HostCpu":{"type":"object","required":["socket","cores","threads","info","type"],"properties":{"socket":{"type":"integer","format":"integer","description":"Number of populated CPU sockets","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Total number of cores (sum of all CPU cores)","readOnly":true},"threads":{"type":"integer","format":"integer","description":"Total number of threads (sum of all CPU threads).","readOnly":true},"info":{"type":"string","format":"","description":"CPU information","readOnly":true},"type":{"type":"string","format":"","description":"CPU type","readOnly":true}},"additionalProperties":false},"HostDisk":{"type":"object","required":["diskType","diskMedium","model","product","diskSerial","firmwareVersion","rotationRate","sectorSizeLogical","sectorSizePhysical","size"],"properties":{"diskType":{"type":"string","format":"","description":"The type of disk","readOnly":true},"diskMedium":{"type":"string","format":"","description":"The medium of this disk","readOnly":true},"model":{"type":"string","format":"","description":"The model name of this disk","readOnly":true},"product":{"type":"string","format":"","description":"The product string of this disk","readOnly":true},"diskSerial":{"type":"string","format":"","description":"The serial number of this disk","readOnly":true},"firmwareVersion":{"type":"string","format":"","description":"Firmware version","readOnly":true},"rotationRate":{"type":"integer","format":"integer","description":"Rotation rate (does not apply to SSD)","readOnly":true},"sectorSizeLogical":{"type":"integer","format":"integer","description":"Logical sector size","readOnly":true},"sectorSizePhysical":{"type":"integer","format":"integer","description":"Physical sector size","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true}},"additionalProperties":false},"HostMemory":{"type":"object","required":["brand","model","size","speed","ecc","memoryBank","memoryType","memorySlot","memorySerial"],"properties":{"brand":{"type":"string","format":"","description":"The brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model name","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true},"speed":{"type":"integer","format":"integer","description":"The speed this memory module runs at","readOnly":true},"ecc":{"type":"integer","format":"integer","description":"Set to 1 if ecc is supported and enabled","readOnly":true},"memoryBank":{"type":"integer","format":"integer","description":"The bank this module sits in","readOnly":true},"memoryType":{"type":"string","format":"","description":"The type of memory module","readOnly":true},"memorySlot":{"type":"string","format":"","description":"The slot this module sits in","readOnly":true},"memorySerial":{"type":"string","format":"","description":"The serial number of this module","readOnly":true}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"HostUplink":{"type":"object","required":["uplinkId","aggregate"],"properties":{"uplinkId":{"type":"integer","format":"integer","description":"The cacti ID of the uplink","readOnly":true},"aggregate":{"type":"boolean","description":"True if the uplink is an aggregated uplink, false if it is not aggregated","readOnly":true}},"additionalProperties":false}}}}
```

## The HostCpu object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"HostCpu":{"type":"object","required":["socket","cores","threads","info","type"],"properties":{"socket":{"type":"integer","format":"integer","description":"Number of populated CPU sockets","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Total number of cores (sum of all CPU cores)","readOnly":true},"threads":{"type":"integer","format":"integer","description":"Total number of threads (sum of all CPU threads).","readOnly":true},"info":{"type":"string","format":"","description":"CPU information","readOnly":true},"type":{"type":"string","format":"","description":"CPU type","readOnly":true}},"additionalProperties":false}}}}
```

## The HostDisk object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"HostDisk":{"type":"object","required":["diskType","diskMedium","model","product","diskSerial","firmwareVersion","rotationRate","sectorSizeLogical","sectorSizePhysical","size"],"properties":{"diskType":{"type":"string","format":"","description":"The type of disk","readOnly":true},"diskMedium":{"type":"string","format":"","description":"The medium of this disk","readOnly":true},"model":{"type":"string","format":"","description":"The model name of this disk","readOnly":true},"product":{"type":"string","format":"","description":"The product string of this disk","readOnly":true},"diskSerial":{"type":"string","format":"","description":"The serial number of this disk","readOnly":true},"firmwareVersion":{"type":"string","format":"","description":"Firmware version","readOnly":true},"rotationRate":{"type":"integer","format":"integer","description":"Rotation rate (does not apply to SSD)","readOnly":true},"sectorSizeLogical":{"type":"integer","format":"integer","description":"Logical sector size","readOnly":true},"sectorSizePhysical":{"type":"integer","format":"integer","description":"Physical sector size","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The HostIP object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"HostIP":{"type":"object","required":["ipAddress","version","type","private","interface","macAddress","rDns","vlanId","gateway","netmask","prefix"],"properties":{"ipAddress":{"type":"string","format":"","description":"Host IP address","readOnly":true},"version":{"type":"integer","format":"integer","description":"IP version, possible values can be 4 or 6","readOnly":true},"type":{"type":"integer","format":"integer","description":"IP type:\n1) normal,\n2) KVM,\n253) VRRP1,\n254) VRRP2,\n255) gateway","readOnly":true},"private":{"type":"integer","format":"integer","description":"Private IP (1) or public IP (0)","readOnly":true},"interface":{"type":"integer","format":"integer","description":"ID of the interface (0-7)","readOnly":true},"macAddress":{"type":"string","format":"","description":"MAC address of the interface","readOnly":true},"rDns":{"type":"string","format":"","description":"RDNS of the interface","readOnly":true},"vlanId":{"type":"integer","format":"integer","description":"ID for the VLAN","nullable":true,"readOnly":true},"gateway":{"type":"string","format":"","description":"Interface gateway","nullable":true,"readOnly":true},"netmask":{"type":"string","format":"","description":"Interface netmask","nullable":true,"readOnly":true},"prefix":{"type":"integer","format":"integer","description":"Interface prefix","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The HostMemory object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"HostMemory":{"type":"object","required":["brand","model","size","speed","ecc","memoryBank","memoryType","memorySlot","memorySerial"],"properties":{"brand":{"type":"string","format":"","description":"The brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model name","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true},"speed":{"type":"integer","format":"integer","description":"The speed this memory module runs at","readOnly":true},"ecc":{"type":"integer","format":"integer","description":"Set to 1 if ecc is supported and enabled","readOnly":true},"memoryBank":{"type":"integer","format":"integer","description":"The bank this module sits in","readOnly":true},"memoryType":{"type":"string","format":"","description":"The type of memory module","readOnly":true},"memorySlot":{"type":"string","format":"","description":"The slot this module sits in","readOnly":true},"memorySerial":{"type":"string","format":"","description":"The serial number of this module","readOnly":true}},"additionalProperties":false}}}}
```

## The HostSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"HostSummary":{"type":"object","required":["id","serverId","serverName","serverType","liveHostName","isVirtual","category","osId","locationId","dcLocationId","instanceType","fleetId","newFleetId","fleetAssociatedSince","rackName","dateStart","dateEnd","dateCancelled","dateEndContract","contractPeriod","extendPeriod","cancellationPeriod","purchaseOrder","paymentTerm","pricePerMonth","pricePerTbOveruse","currencyId","bandwidthBillingType","bandwidthContractual","brand","model","isReserve","serviceTag","isODP","fmOrderId","installStatus","status","trafficSum","freeIncomingTraffic","outgoingTrafficSum","incomingTrafficSum"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this host","readOnly":true},"serverId":{"type":"integer","format":"integer","description":"The ID of the physical machine","readOnly":true},"serverName":{"type":"string","format":"","description":"The name of the physical machine","readOnly":true},"serverType":{"type":"integer","format":"integer","description":"The type of the server:\n* 1: Bare metal server\n* 2: Flex metal server\n* 3: Virtual machine","readOnly":true},"projectName":{"type":"string","format":"","description":"The name of the project for the host"},"clientServerName":{"type":"string","format":"","description":"The name of the server defined by client"},"clientState":{"type":"string","format":"","description":"Client statement for the host"},"liveHostName":{"type":"string","format":"","description":"The host name","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this is a bare metal server, 1 if it's a VM. Use `serverType` instead","readOnly":true,"deprecated":true},"category":{"type":"string","format":"","description":"Host category. Normally \"Dedicated Game Servers\" or \"Dedicated Servers\", but can be \"Broken\" if the server is in a degraded state","readOnly":true},"osId":{"type":"integer","format":"integer","description":"Operating system ID, must be one of [`GET /v3/operatingsystem`](all#/OperatingSystem/getOperatingsystems)","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"Legacy location ID (not used for ODP)","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","description":"Datacenter location ID. Points to one of [`GET /v3/cloud/dcLocation`](#/Cloud/getCloudDcLocations)","readOnly":true},"instanceType":{"type":"string","format":"","description":"The instance type of this server, which is one of [`GET /v3/host/instanceType`](#/Host/getHostInstanceTypes) for a bare metal, or one of\n[`GET /v3/cloud/instanceType`](#/Cloud/getCloudInstanceTypes) for a virtual machine","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID, if this host has been assigned to a fleet\nIf `0`, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.","readOnly":true},"newFleetId":{"type":"string","format":"","description":"The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at [`POST /v3/fleet/host/bulkReserve`](#/Fleet/createFleetHostBulkReserve)","nullable":true,"readOnly":true},"fleetAssociatedSince":{"type":"integer","format":"integer","description":"Unix timestamp when fleet assigned to the host","readOnly":true},"rackName":{"type":"string","format":"","description":"The name of the rack the host is located","readOnly":true},"dateStart":{"type":"string","format":"","description":"The date at which this host became active","readOnly":true},"dateEnd":{"type":"string","format":"","description":"The date at which this host will expire","readOnly":true},"dateCancelled":{"type":"string","format":"","description":"The date at which this host was cancelled","readOnly":true},"dateEndContract":{"type":"string","format":"","description":"The date at which the contract ends (if applicable)","readOnly":true},"contractPeriod":{"type":"integer","format":"integer","description":"The contract period in months","readOnly":true},"extendPeriod":{"type":"integer","format":"integer","description":"The service extend period in months","readOnly":true},"cancellationPeriod":{"type":"integer","format":"integer","description":"The cancellation period in months","readOnly":true},"purchaseOrder":{"type":"string","format":"","description":"Purchase order, if one has been supplied via our billing department","readOnly":true},"paymentTerm":{"type":"integer","format":"integer","description":"The payment term in days (how many days are invoices generated before dateEnd)","readOnly":true},"pricePerMonth":{"type":"string","format":"","description":"The price of this host per month in cents (see `currencyId` for currency)","readOnly":true},"pricePerTbOveruse":{"type":"string","format":"","description":"The price of traffic overuse in cents (per TB) (see `currencyId` for currency)","readOnly":true},"currencyId":{"type":"integer","format":"integer","description":"The currency of the `pricePerMonth` field:\n* 0: EURO\n* 1: USD\n* 9: YEN","readOnly":true},"bandwidthBillingType":{"type":"integer","format":"integer","description":"The bandwidth billing method for this service:\n* 1: unmetered connection\n* 2: measured in TB per month\n* 3: measured in mbit 95th percentile","readOnly":true},"bandwidthContractual":{"type":"integer","format":"integer","description":"The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals `2`, in mbit otherwise","readOnly":true},"brand":{"type":"string","format":"","description":"The server manufacturer brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model of the server","readOnly":true},"isReserve":{"type":"integer","format":"integer","description":"If the host is reserved for a fleet isReserve set to 1","readOnly":true},"serviceTag":{"type":"string","format":"","description":"The service tag of the host","readOnly":true},"isODP":{"type":"integer","format":"integer","description":"If the host is available for game hosting platform isODP set to 1","readOnly":true},"fmOrderId":{"type":"string","format":"","description":"ID of Flex Metal order if this is a flex metal server","nullable":true,"readOnly":true},"installStatus":{"type":"string","format":"","description":"Status of server auto install if it was started by one. (created / installing / finished / failed)","nullable":true,"readOnly":true},"status":{"type":"string","format":"","description":"Whether the host is running or not","readOnly":true},"uptime":{"type":"integer","format":"integer","description":"The uptime of the host. Read-only. Only provided if the server checked-in recently"},"trafficSum":{"type":"integer","format":"integer","description":"Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration","readOnly":true},"freeIncomingTraffic":{"type":"boolean","description":"Whether the host has free incoming traffic or not","readOnly":true},"outgoingTrafficSum":{"type":"integer","format":"integer","description":"The outgoing traffic (Mbit or GB)","readOnly":true},"incomingTrafficSum":{"type":"integer","format":"integer","description":"The incoming traffic (Mbit or GB)","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUplink object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUplink":{"type":"object","required":["uplinkId","aggregate"],"properties":{"uplinkId":{"type":"integer","format":"integer","description":"The cacti ID of the uplink","readOnly":true},"aggregate":{"type":"boolean","description":"True if the uplink is an aggregated uplink, false if it is not aggregated","readOnly":true}},"additionalProperties":false}}}}
```

## The InitialAccount object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"InitialAccount":{"type":"object","required":["id","username","email","firstName","lastName","newsletter","agreeToc","agreeAup","agreeDpa"],"properties":{"id":{"type":"integer","format":"integer","description":"User ID"},"username":{"type":"string","format":"","description":"User Name"},"email":{"type":"string","format":"","description":"Email"},"firstName":{"type":"string","format":"","description":"First name."},"lastName":{"type":"string","format":"","description":"Last name."},"newsletter":{"type":"integer","format":"integer","description":"Whether or not newsletter is subscribed to"},"agreeToc":{"type":"integer","format":"integer","description":"Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing."},"agreeAup":{"type":"integer","format":"integer","description":"Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing."},"agreeDpa":{"type":"integer","format":"integer","description":"Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing."}},"additionalProperties":false}}}}
```

## The Invoice object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Invoice":{"type":"object","required":["id","creationDate","dueDate","invoiceNumber","invoiceHash","description","currency","currencySign","amountIncVAT","amountExclVAT","paymentStatus","paymentDate","isCredit","remainingAmount","totalPaidAmount"],"properties":{"id":{"type":"string","format":"","description":"The ID of the invoice","readOnly":true},"creationDate":{"type":"integer","format":"integer","description":"The date the invoice was created","readOnly":true},"dueDate":{"type":"integer","format":"integer","description":"The due date of the invoice","readOnly":true},"invoiceNumber":{"type":"string","format":"","description":"The number of the invoice","readOnly":true},"invoiceHash":{"type":"string","format":"","description":"A unique hash for this invoice","readOnly":true},"description":{"type":"string","format":"","description":"The description of the invoice"},"currency":{"type":"string","format":"","description":"The currency that is being used"},"currencySign":{"type":"string","format":"","description":"The currency sign that is being used"},"amountIncVAT":{"type":"string","format":"","description":"The amount of the invoice with VAT in cents"},"amountExclVAT":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents"},"paymentStatus":{"type":"integer","format":"integer","description":"The payment status"},"paymentDate":{"type":"integer","format":"integer","description":"The timestamp that the invoice was paid, if paid"},"isCredit":{"type":"integer","format":"integer","description":"If this field is 1 it means that invoice is a credit invoice"},"remainingAmount":{"type":"string","format":"","description":"The remaining amount of invoice"},"totalPaidAmount":{"type":"string","format":"","description":"The total paid amount of invoice"}},"additionalProperties":false}}}}
```

## The InvoiceClientDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"InvoiceClientDetails":{"type":"object","required":["fullName","companyName","email","address","zip","city","country","vatNumber","iban","bic"],"properties":{"fullName":{"type":"string","format":"","description":"Full name of the client","readOnly":true},"companyName":{"type":"string","format":"","description":"Name of the company of the client","readOnly":true},"email":{"type":"string","format":"","description":"Client email","readOnly":true},"address":{"type":"string","format":"","description":"Client address","readOnly":true},"zip":{"type":"string","format":"","description":"Client address ZIP code","readOnly":true},"city":{"type":"string","format":"","description":"Client address city","readOnly":true},"country":{"type":"string","format":"","description":"Client address country","readOnly":true},"vatNumber":{"type":"string","format":"","description":"Client VAT number","readOnly":true},"iban":{"type":"string","format":"","description":"Client bank account IBAN number","readOnly":true},"bic":{"type":"string","format":"","description":"Client bank account BIC number","readOnly":true}},"additionalProperties":false}}}}
```

## The InvoiceCompanyDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"InvoiceCompanyDetails":{"type":"object","required":["name","address","zip","city","country","phone","email","url","iban","bic"],"properties":{"name":{"type":"string","format":"","description":"Company name","readOnly":true},"address":{"type":"string","format":"","description":"Company address","readOnly":true},"zip":{"type":"string","format":"","description":"Company ZIP code","readOnly":true},"city":{"type":"string","format":"","description":"Company address city","readOnly":true},"country":{"type":"string","format":"","description":"Company country","readOnly":true},"phone":{"type":"string","format":"","description":"Company phone","readOnly":true},"email":{"type":"string","format":"","description":"Company phone email address","readOnly":true},"url":{"type":"string","format":"","description":"Company website URL","readOnly":true},"iban":{"type":"string","format":"","description":"Company bank account IBAN number","readOnly":true},"bic":{"type":"string","format":"","description":"Company bank account BIC number","readOnly":true}},"additionalProperties":false}}}}
```

## The InvoiceDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"InvoiceDetails":{"type":"object","required":["id","invoiceNumber","invoiceHash","clientNumber","creationDate","dueDate","paymentStatus","paymentDate","isCredit","paymentTerm","currency","currencySign","vatPercentage","vatAmount","amountIncVat","amountExclVat","items","clientDetails","companyDetails"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the invoice","readOnly":true},"invoiceNumber":{"type":"string","format":"","description":"Invoice number","readOnly":true},"invoiceHash":{"type":"string","format":"","description":"A unique hash for this invoice","readOnly":true},"clientNumber":{"type":"string","format":"","description":"Client number","readOnly":true},"creationDate":{"type":"string","format":"","description":"The date the invoice was created","readOnly":true},"dueDate":{"type":"string","format":"","description":"The due date of the invoice","readOnly":true},"paymentStatus":{"type":"integer","format":"integer","description":"Whether or not the invoice was paid","readOnly":true},"paymentDate":{"type":"integer","format":"integer","description":"The timestamp that the invoice was paid, if paid"},"isCredit":{"type":"integer","format":"integer","description":"If this field is 1 it means that invoice is a credit invoice"},"paymentTerm":{"type":"integer","format":"integer","description":"The invoice must be paid in the given amount of time (days)","readOnly":true},"currency":{"type":"string","format":"","description":"The name of the currency that is being used","readOnly":true},"currencySign":{"type":"string","format":"","description":"The sign of the currency that is being used","readOnly":true},"vatPercentage":{"type":"integer","format":"integer","description":"Percentage of VAT applied","readOnly":true},"vatAmount":{"type":"string","format":"","description":"Amount of VAT to pay in cents","readOnly":true},"amountIncVat":{"type":"string","format":"","description":"The amount of the invoice with VAT included in cents","readOnly":true},"amountExclVat":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents","readOnly":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"},"description":"Invoice items","readOnly":true},"clientDetails":{"allOf":[{"$ref":"#/components/schemas/InvoiceClientDetails"}],"description":"Client details","readOnly":true},"companyDetails":{"allOf":[{"$ref":"#/components/schemas/InvoiceCompanyDetails"}],"description":"Company details","readOnly":true}},"additionalProperties":false},"InvoiceItem":{"type":"object","required":["orderId","description","periodFrom","periodTo","remarks","quantity","setupCosts","unitPrice","vatPercentage","vatAmount","amountIncVat","amountExclVat"],"properties":{"orderId":{"type":"string","format":"","description":"Purchase order ID of the item","readOnly":true},"description":{"type":"string","format":"","description":"Invoice item description","readOnly":true},"periodFrom":{"type":"string","format":"","description":"Invoiced period start for the item","readOnly":true},"periodTo":{"type":"string","format":"","description":"Invoiced period end for the item","readOnly":true},"remarks":{"type":"string","format":"","description":"Invoice item remarks","readOnly":true},"quantity":{"type":"integer","format":"integer","description":"Invoice item quantity","readOnly":true},"setupCosts":{"type":"string","format":"","description":"Invoice item setup costs in cents","readOnly":true},"unitPrice":{"type":"string","format":"","description":"Price of one unit of invoice item in cents","readOnly":true},"vatPercentage":{"type":"integer","format":"integer","description":"Percentage of VAT applied","readOnly":true},"vatAmount":{"type":"string","format":"","description":"Amount of VAT to pay in cents","readOnly":true},"amountIncVat":{"type":"string","format":"","description":"The amount of the invoice with VAT included in cents","readOnly":true},"amountExclVat":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents","readOnly":true}},"additionalProperties":false},"InvoiceClientDetails":{"type":"object","required":["fullName","companyName","email","address","zip","city","country","vatNumber","iban","bic"],"properties":{"fullName":{"type":"string","format":"","description":"Full name of the client","readOnly":true},"companyName":{"type":"string","format":"","description":"Name of the company of the client","readOnly":true},"email":{"type":"string","format":"","description":"Client email","readOnly":true},"address":{"type":"string","format":"","description":"Client address","readOnly":true},"zip":{"type":"string","format":"","description":"Client address ZIP code","readOnly":true},"city":{"type":"string","format":"","description":"Client address city","readOnly":true},"country":{"type":"string","format":"","description":"Client address country","readOnly":true},"vatNumber":{"type":"string","format":"","description":"Client VAT number","readOnly":true},"iban":{"type":"string","format":"","description":"Client bank account IBAN number","readOnly":true},"bic":{"type":"string","format":"","description":"Client bank account BIC number","readOnly":true}},"additionalProperties":false},"InvoiceCompanyDetails":{"type":"object","required":["name","address","zip","city","country","phone","email","url","iban","bic"],"properties":{"name":{"type":"string","format":"","description":"Company name","readOnly":true},"address":{"type":"string","format":"","description":"Company address","readOnly":true},"zip":{"type":"string","format":"","description":"Company ZIP code","readOnly":true},"city":{"type":"string","format":"","description":"Company address city","readOnly":true},"country":{"type":"string","format":"","description":"Company country","readOnly":true},"phone":{"type":"string","format":"","description":"Company phone","readOnly":true},"email":{"type":"string","format":"","description":"Company phone email address","readOnly":true},"url":{"type":"string","format":"","description":"Company website URL","readOnly":true},"iban":{"type":"string","format":"","description":"Company bank account IBAN number","readOnly":true},"bic":{"type":"string","format":"","description":"Company bank account BIC number","readOnly":true}},"additionalProperties":false}}}}
```

## The InvoiceItem object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"InvoiceItem":{"type":"object","required":["orderId","description","periodFrom","periodTo","remarks","quantity","setupCosts","unitPrice","vatPercentage","vatAmount","amountIncVat","amountExclVat"],"properties":{"orderId":{"type":"string","format":"","description":"Purchase order ID of the item","readOnly":true},"description":{"type":"string","format":"","description":"Invoice item description","readOnly":true},"periodFrom":{"type":"string","format":"","description":"Invoiced period start for the item","readOnly":true},"periodTo":{"type":"string","format":"","description":"Invoiced period end for the item","readOnly":true},"remarks":{"type":"string","format":"","description":"Invoice item remarks","readOnly":true},"quantity":{"type":"integer","format":"integer","description":"Invoice item quantity","readOnly":true},"setupCosts":{"type":"string","format":"","description":"Invoice item setup costs in cents","readOnly":true},"unitPrice":{"type":"string","format":"","description":"Price of one unit of invoice item in cents","readOnly":true},"vatPercentage":{"type":"integer","format":"integer","description":"Percentage of VAT applied","readOnly":true},"vatAmount":{"type":"string","format":"","description":"Amount of VAT to pay in cents","readOnly":true},"amountIncVat":{"type":"string","format":"","description":"The amount of the invoice with VAT included in cents","readOnly":true},"amountExclVat":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents","readOnly":true}},"additionalProperties":false}}}}
```

## The IpRangeCidr object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"IpRangeCidr":{"type":"object","required":["network","netmask","prefix","gateway","rDns"],"properties":{"network":{"type":"string","format":"","description":"The ip of the network","readOnly":true},"netmask":{"type":"string","format":"","description":"The range netmask","readOnly":true},"prefix":{"type":"string","format":"","description":"CIDR prefix, including leading slash","readOnly":true},"gateway":{"type":"string","format":"","description":"The gateway IP","readOnly":true},"vrrp1":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"vrrp2":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"rDns":{"type":"array","items":{"$ref":"#/components/schemas/RDns"},"description":"RDNS records","readOnly":true}},"additionalProperties":false},"RDns":{"type":"object","required":["hostname","ip"],"properties":{"hostname":{"type":"string","format":"","description":"The hostname"},"ip":{"type":"string","format":"","description":"The corresponding ip for the host","readOnly":true}},"additionalProperties":false}}}}
```

## The IpRangeCustom object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"IpRangeCustom":{"type":"object","required":["networkStart","networkEnd","gateway","rDns"],"properties":{"networkStart":{"type":"string","format":"","description":"The start ip of the network","readOnly":true},"networkEnd":{"type":"string","format":"","description":"The end ip of the network","readOnly":true},"gateway":{"type":"string","format":"","description":"The gateway IP","readOnly":true},"vrrp1":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"vrrp2":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"rDns":{"type":"array","items":{"$ref":"#/components/schemas/RDns"},"description":"RDNS records","readOnly":true}},"additionalProperties":false},"RDns":{"type":"object","required":["hostname","ip"],"properties":{"hostname":{"type":"string","format":"","description":"The hostname"},"ip":{"type":"string","format":"","description":"The corresponding ip for the host","readOnly":true}},"additionalProperties":false}}}}
```

## The Job object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Job":{"type":"object","required":["id","slug","title","headerImage","tileImage","introText","text","intakeDate"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the job"},"slug":{"type":"string","format":"","description":"Title in url format"},"title":{"type":"string","format":"","description":"Job title"},"headerImage":{"type":"string","format":"","description":"Image to display as the header for the job details page"},"tileImage":{"type":"string","format":"","description":"Image to use on the over view page for this job"},"introText":{"type":"string","format":"","description":"Job introductory text"},"text":{"type":"string","format":"","description":"Job description text"},"intakeDate":{"type":"integer","format":"integer","description":"Unix timestamp of the (final) intake date"}},"additionalProperties":false}}}}
```

## The Label object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false}}}}
```

## The MemoryTriggerRule object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"MemoryTriggerRule":{"type":"object","required":["operator","triggerWindow","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET /v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"triggerWindow":{"type":"integer","format":"integer","description":"The time window for a rule, time will be in seconds"},"threshold":{"type":"integer","format":"integer","description":"The amount of memory were the event should be triggered on in MB"}},"additionalProperties":false}}}}
```

## The Network object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Network":{"type":"object","required":["vlanId","ipRange","ipRangeCustom"],"properties":{"vlanId":{"type":"integer","format":"integer","description":"The vlan ID","readOnly":true},"ipRange":{"type":"array","items":{"$ref":"#/components/schemas/IpRangeCidr"},"description":"Defines a list of IP ranges with a prefix in CIDR format (such as 123.123.123.64/26)","readOnly":true},"ipRangeCustom":{"type":"array","items":{"$ref":"#/components/schemas/IpRangeCustom"},"description":"Defines a list of custom IP ranges that do not use prefixes but have an arbitrary start and end ip range (such as 123.123.123.100 - 123.123.123.200)","readOnly":true}},"additionalProperties":false},"IpRangeCidr":{"type":"object","required":["network","netmask","prefix","gateway","rDns"],"properties":{"network":{"type":"string","format":"","description":"The ip of the network","readOnly":true},"netmask":{"type":"string","format":"","description":"The range netmask","readOnly":true},"prefix":{"type":"string","format":"","description":"CIDR prefix, including leading slash","readOnly":true},"gateway":{"type":"string","format":"","description":"The gateway IP","readOnly":true},"vrrp1":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"vrrp2":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"rDns":{"type":"array","items":{"$ref":"#/components/schemas/RDns"},"description":"RDNS records","readOnly":true}},"additionalProperties":false},"RDns":{"type":"object","required":["hostname","ip"],"properties":{"hostname":{"type":"string","format":"","description":"The hostname"},"ip":{"type":"string","format":"","description":"The corresponding ip for the host","readOnly":true}},"additionalProperties":false},"IpRangeCustom":{"type":"object","required":["networkStart","networkEnd","gateway","rDns"],"properties":{"networkStart":{"type":"string","format":"","description":"The start ip of the network","readOnly":true},"networkEnd":{"type":"string","format":"","description":"The end ip of the network","readOnly":true},"gateway":{"type":"string","format":"","description":"The gateway IP","readOnly":true},"vrrp1":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"vrrp2":{"type":"string","format":"","description":"The virtual router redundancy protocol 1","nullable":true},"rDns":{"type":"array","items":{"$ref":"#/components/schemas/RDns"},"description":"RDNS records","readOnly":true}},"additionalProperties":false}}}}
```

## The NewsletterConfirm object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"NewsletterConfirm":{"type":"object","required":["token"],"properties":{"token":{"type":"string","format":"uuid","description":"The confirmation token from the opt-in email."}},"additionalProperties":false}}}}
```

## The NewsletterOptIn object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"NewsletterOptIn":{"type":"object","required":["email","language"],"properties":{"email":{"type":"string","maxLength":128,"format":"","description":"Customer's email address"},"language":{"type":"string","format":"","description":"Customer's preferred language"}},"additionalProperties":false}}}}
```

## The NewsletterUnsubscribe object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"NewsletterUnsubscribe":{"type":"object","required":["mailhash","key"],"properties":{"mailhash":{"type":"string","format":"","description":"A hash, as provided in the newsletter unsubscribe url"},"key":{"type":"string","format":"","description":"A key, as provided in the newsletter unsubscribe url"}},"additionalProperties":false}}}}
```

## The OnlineStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"OnlineStatus":{"type":"object","required":["status","groups"],"properties":{"status":{"type":"integer","format":"integer","description":"The status of all the systems\n* 1: All systems operational\n* 2: Multiple systems have performance issues\n* 3: Multiple systems are offline\n* 4: All systems are offline","readOnly":true},"groups":{"type":"array","items":{"$ref":"#/components/schemas/OnlineStatusGroup"},"description":"A list of groups with more detailed status","readOnly":true}},"additionalProperties":false},"OnlineStatusGroup":{"type":"object","required":["name","status","components"],"properties":{"name":{"type":"string","format":"","description":"The name of the group","readOnly":true},"status":{"type":"integer","format":"integer","description":"The status of the group\n* 1: All systems operational\n* 2: Multiple systems have performance issues\n* 3: Multiple systems are offline\n* 4: All systems are offline","readOnly":true},"components":{"type":"array","items":{"$ref":"#/components/schemas/OnlineStatusComponent"},"description":"A list of components for this group","readOnly":true}},"additionalProperties":false},"OnlineStatusComponent":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","format":"","description":"The name of the component","readOnly":true},"status":{"type":"integer","format":"integer","description":"The status of the component\n* 1: All systems operational\n* 2: Multiple systems have performance issues\n* 3: Multiple systems are offline\n* 4: All systems are offline","readOnly":true}},"additionalProperties":false}}}}
```

## The OnlineStatusComponent object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"OnlineStatusComponent":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","format":"","description":"The name of the component","readOnly":true},"status":{"type":"integer","format":"integer","description":"The status of the component\n* 1: All systems operational\n* 2: Multiple systems have performance issues\n* 3: Multiple systems are offline\n* 4: All systems are offline","readOnly":true}},"additionalProperties":false}}}}
```

## The OnlineStatusGroup object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"OnlineStatusGroup":{"type":"object","required":["name","status","components"],"properties":{"name":{"type":"string","format":"","description":"The name of the group","readOnly":true},"status":{"type":"integer","format":"integer","description":"The status of the group\n* 1: All systems operational\n* 2: Multiple systems have performance issues\n* 3: Multiple systems are offline\n* 4: All systems are offline","readOnly":true},"components":{"type":"array","items":{"$ref":"#/components/schemas/OnlineStatusComponent"},"description":"A list of components for this group","readOnly":true}},"additionalProperties":false},"OnlineStatusComponent":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","format":"","description":"The name of the component","readOnly":true},"status":{"type":"integer","format":"integer","description":"The status of the component\n* 1: All systems operational\n* 2: Multiple systems have performance issues\n* 3: Multiple systems are offline\n* 4: All systems are offline","readOnly":true}},"additionalProperties":false}}}}
```

## The OperatingSystem object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"OperatingSystem":{"type":"object","required":["id","name","slug","osGroup","isOdp","availableForFlexMetal","active"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this operating system","readOnly":true},"name":{"type":"string","format":"","description":"The name of this operating system","readOnly":true},"slug":{"type":"string","format":"","description":"Unique key for operating system","readOnly":true},"osGroup":{"type":"integer","format":"integer","description":"The operating system group.\n1) Windows\n2) Linux / BSD","readOnly":true},"isOdp":{"type":"integer","format":"integer","description":"`1` if you can use this operating system with ODP, `0` otherwise.","readOnly":true},"availableForFlexMetal":{"type":"integer","format":"integer","description":"`1` if you can use this operating system with Flex Metal, `0` otherwise.","readOnly":true},"active":{"type":"integer","format":"integer","description":"`1` if this operating system is an active operating system, `0` otherwise.","readOnly":true}},"additionalProperties":false}}}}
```

## The PasswordChange object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PasswordChange":{"type":"object","required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string","format":"","description":"Current Password"},"newPassword":{"type":"string","format":"","description":"New Password"}},"additionalProperties":false}}}}
```

## The PasswordReset object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PasswordReset":{"type":"object","required":["emailAddress"],"properties":{"emailAddress":{"type":"string","format":"","description":"Main Email Address"}},"additionalProperties":false}}}}
```

## The PasswordResetValidate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PasswordResetValidate":{"type":"object","required":["newPassword","resetHash"],"properties":{"newPassword":{"type":"string","format":"","description":"New Password"},"resetHash":{"type":"string","format":"","description":"Reset Hash"}},"additionalProperties":false}}}}
```

## The PayPrepare object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PayPrepare":{"type":"object","required":["totalAmount","currency","currencySign","totalSelectedInvoiceForPay","totalSelectedCreditForSettle","accountCredit"],"properties":{"totalAmount":{"type":"string","format":"","description":"The total amount of the selected invoices","readOnly":true},"currency":{"type":"string","format":"","description":"The currency that is being used"},"currencySign":{"type":"string","format":"","description":"The currency sign that is being used"},"totalSelectedInvoiceForPay":{"type":"integer","format":"integer","description":"The total selected invoices for pay"},"totalSelectedCreditForSettle":{"type":"integer","format":"integer","description":"The total selected credit invoices for settle"},"accountCredit":{"type":"string","format":"","description":"The amount of the account credit"},"invoicesForPay":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"},"description":"The selected invoices for pay"},"creditInvoices":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"},"description":"The open credit invoices"},"paymentMethod":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"},"description":"The payment method"}},"additionalProperties":false},"Invoice":{"type":"object","required":["id","creationDate","dueDate","invoiceNumber","invoiceHash","description","currency","currencySign","amountIncVAT","amountExclVAT","paymentStatus","paymentDate","isCredit","remainingAmount","totalPaidAmount"],"properties":{"id":{"type":"string","format":"","description":"The ID of the invoice","readOnly":true},"creationDate":{"type":"integer","format":"integer","description":"The date the invoice was created","readOnly":true},"dueDate":{"type":"integer","format":"integer","description":"The due date of the invoice","readOnly":true},"invoiceNumber":{"type":"string","format":"","description":"The number of the invoice","readOnly":true},"invoiceHash":{"type":"string","format":"","description":"A unique hash for this invoice","readOnly":true},"description":{"type":"string","format":"","description":"The description of the invoice"},"currency":{"type":"string","format":"","description":"The currency that is being used"},"currencySign":{"type":"string","format":"","description":"The currency sign that is being used"},"amountIncVAT":{"type":"string","format":"","description":"The amount of the invoice with VAT in cents"},"amountExclVAT":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents"},"paymentStatus":{"type":"integer","format":"integer","description":"The payment status"},"paymentDate":{"type":"integer","format":"integer","description":"The timestamp that the invoice was paid, if paid"},"isCredit":{"type":"integer","format":"integer","description":"If this field is 1 it means that invoice is a credit invoice"},"remainingAmount":{"type":"string","format":"","description":"The remaining amount of invoice"},"totalPaidAmount":{"type":"string","format":"","description":"The total paid amount of invoice"}},"additionalProperties":false},"PaymentMethod":{"type":"object","required":["id","name","isSelectable","paymentProviderId"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the payment method"},"name":{"type":"string","format":"","description":"The name of the payment method"},"isSelectable":{"type":"integer","format":"integer","description":"if this field is 1 the end-user can use this payment method for the payment"},"paymentProviderId":{"type":"integer","format":"integer","description":"The id of the payment provider"},"issuers":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodIssuers"},"description":"the issuers of the payment method"}},"additionalProperties":false},"PaymentMethodIssuers":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of payment method issuer","readOnly":true},"name":{"type":"string","format":"","description":"The name of payment method issuer"}},"additionalProperties":false}}}}
```

## The PayRegister object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PayRegister":{"type":"object","required":["invoiceIds","paymentMethodId","issuerId"],"properties":{"invoiceIds":{"type":"string","format":""},"paymentMethodId":{"type":"integer","format":"integer"},"issuerId":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The PayRegisterResponse object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PayRegisterResponse":{"type":"object","required":["requestUrl","postFormInputs","accountCredit","totalAmount","paymentMethod","invoicesForPay"],"properties":{"requestUrl":{"type":"string","format":"","description":"URL where to send the user with post form data"},"postFormInputs":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Any data that should be sent to payment provider"},"accountCredit":{"type":"string","format":"","description":"The amount of the account credit"},"totalAmount":{"type":"string","format":"","description":"Total amount to pay"},"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethod"}],"description":"Chosen payment method"},"invoicesForPay":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"},"description":"Invoices to pay","readOnly":true}},"additionalProperties":false},"PaymentMethod":{"type":"object","required":["id","name","isSelectable","paymentProviderId"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the payment method"},"name":{"type":"string","format":"","description":"The name of the payment method"},"isSelectable":{"type":"integer","format":"integer","description":"if this field is 1 the end-user can use this payment method for the payment"},"paymentProviderId":{"type":"integer","format":"integer","description":"The id of the payment provider"},"issuers":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodIssuers"},"description":"the issuers of the payment method"}},"additionalProperties":false},"PaymentMethodIssuers":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of payment method issuer","readOnly":true},"name":{"type":"string","format":"","description":"The name of payment method issuer"}},"additionalProperties":false},"Invoice":{"type":"object","required":["id","creationDate","dueDate","invoiceNumber","invoiceHash","description","currency","currencySign","amountIncVAT","amountExclVAT","paymentStatus","paymentDate","isCredit","remainingAmount","totalPaidAmount"],"properties":{"id":{"type":"string","format":"","description":"The ID of the invoice","readOnly":true},"creationDate":{"type":"integer","format":"integer","description":"The date the invoice was created","readOnly":true},"dueDate":{"type":"integer","format":"integer","description":"The due date of the invoice","readOnly":true},"invoiceNumber":{"type":"string","format":"","description":"The number of the invoice","readOnly":true},"invoiceHash":{"type":"string","format":"","description":"A unique hash for this invoice","readOnly":true},"description":{"type":"string","format":"","description":"The description of the invoice"},"currency":{"type":"string","format":"","description":"The currency that is being used"},"currencySign":{"type":"string","format":"","description":"The currency sign that is being used"},"amountIncVAT":{"type":"string","format":"","description":"The amount of the invoice with VAT in cents"},"amountExclVAT":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents"},"paymentStatus":{"type":"integer","format":"integer","description":"The payment status"},"paymentDate":{"type":"integer","format":"integer","description":"The timestamp that the invoice was paid, if paid"},"isCredit":{"type":"integer","format":"integer","description":"If this field is 1 it means that invoice is a credit invoice"},"remainingAmount":{"type":"string","format":"","description":"The remaining amount of invoice"},"totalPaidAmount":{"type":"string","format":"","description":"The total paid amount of invoice"}},"additionalProperties":false}}}}
```

## The PaymentLandingResponse object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PaymentLandingResponse":{"type":"object","required":["message","status","paymentMethod","invoices"],"properties":{"message":{"type":"string","format":"","description":"Payment processing result message","readOnly":true},"status":{"type":"string","format":"","description":"Payment processing result status","readOnly":true},"paymentMethod":{"type":"string","format":"","description":"The method of the payment","readOnly":true},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"},"description":"Payment invoices","readOnly":true}},"additionalProperties":false},"Invoice":{"type":"object","required":["id","creationDate","dueDate","invoiceNumber","invoiceHash","description","currency","currencySign","amountIncVAT","amountExclVAT","paymentStatus","paymentDate","isCredit","remainingAmount","totalPaidAmount"],"properties":{"id":{"type":"string","format":"","description":"The ID of the invoice","readOnly":true},"creationDate":{"type":"integer","format":"integer","description":"The date the invoice was created","readOnly":true},"dueDate":{"type":"integer","format":"integer","description":"The due date of the invoice","readOnly":true},"invoiceNumber":{"type":"string","format":"","description":"The number of the invoice","readOnly":true},"invoiceHash":{"type":"string","format":"","description":"A unique hash for this invoice","readOnly":true},"description":{"type":"string","format":"","description":"The description of the invoice"},"currency":{"type":"string","format":"","description":"The currency that is being used"},"currencySign":{"type":"string","format":"","description":"The currency sign that is being used"},"amountIncVAT":{"type":"string","format":"","description":"The amount of the invoice with VAT in cents"},"amountExclVAT":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents"},"paymentStatus":{"type":"integer","format":"integer","description":"The payment status"},"paymentDate":{"type":"integer","format":"integer","description":"The timestamp that the invoice was paid, if paid"},"isCredit":{"type":"integer","format":"integer","description":"If this field is 1 it means that invoice is a credit invoice"},"remainingAmount":{"type":"string","format":"","description":"The remaining amount of invoice"},"totalPaidAmount":{"type":"string","format":"","description":"The total paid amount of invoice"}},"additionalProperties":false}}}}
```

## The PaymentMethod object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PaymentMethod":{"type":"object","required":["id","name","isSelectable","paymentProviderId"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the payment method"},"name":{"type":"string","format":"","description":"The name of the payment method"},"isSelectable":{"type":"integer","format":"integer","description":"if this field is 1 the end-user can use this payment method for the payment"},"paymentProviderId":{"type":"integer","format":"integer","description":"The id of the payment provider"},"issuers":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodIssuers"},"description":"the issuers of the payment method"}},"additionalProperties":false},"PaymentMethodIssuers":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of payment method issuer","readOnly":true},"name":{"type":"string","format":"","description":"The name of payment method issuer"}},"additionalProperties":false}}}}
```

## The PaymentMethodIssuers object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PaymentMethodIssuers":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of payment method issuer","readOnly":true},"name":{"type":"string","format":"","description":"The name of payment method issuer"}},"additionalProperties":false}}}}
```

## The Pdu object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Pdu":{"type":"object","required":["id","name","serial","updatedAt","inputFeedType","outlets","phases","powerMeter","powerFactor","amperage","peakAmperage","voltage","minVoltage","conduits"],"properties":{"id":{"type":"integer","format":"integer","description":"The id of feed","readOnly":true},"name":{"type":"string","format":"","description":"The feed name"},"serial":{"type":"string","format":"","description":"The serial number"},"updatedAt":{"type":"integer","format":"integer","description":"The last update time"},"inputFeedType":{"type":"string","format":"","description":"The feed type"},"outlets":{"type":"integer","format":"integer","description":"The number of outlets on this pdu"},"phases":{"type":"integer","format":"integer","description":"The number of phases that this pdu supports"},"powerMeter":{"type":"integer","format":"integer","description":"The last registered counter value"},"powerFactor":{"type":"number","format":"float","description":"The total power factor"},"amperage":{"type":"number","format":"float","description":"The total amperage supported by pdu"},"peakAmperage":{"type":"number","format":"float","description":"The peak amperage"},"voltage":{"type":"number","format":"float","description":"The total actual voltage"},"minVoltage":{"type":"number","format":"float","description":"The total min voltage"},"conduits":{"type":"array","items":{"$ref":"#/components/schemas/Conduit"},"description":"The details of the outlets","readOnly":true}},"additionalProperties":false},"Conduit":{"type":"object","required":["conduitName","powerMeter","amperage","peakAmperage"],"properties":{"conduitName":{"type":"string","format":"","description":"The feed name"},"powerMeter":{"type":"integer","format":"integer","description":"The last registered counter value for this outlet"},"amperage":{"type":"number","format":"float","description":"The total amperage supported by the outlet"},"peakAmperage":{"type":"number","format":"float","description":"The peak amperage"}},"additionalProperties":false}}}}
```

## The PingSite object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSite":{"type":"object","required":["continentId","continentName","countryId","country","dcLocationId","dcLocationName","hostname","ipv4","ipv6"],"properties":{"continentId":{"type":"integer","format":"integer","description":"The ID of the continent"},"continentName":{"type":"string","format":"","description":"The name of the continent"},"countryId":{"type":"integer","format":"integer","description":"The ID of the country"},"country":{"type":"string","format":"","description":"The name of the country"},"dcLocationId":{"type":"integer","format":"integer","description":"The ID of the data center. Find all possible values from `GET /cloud/dcLocation`"},"dcLocationName":{"type":"string","format":"","description":"The name of the data center. Find all possible values from `GET /cloud/dcLocation`"},"hostname":{"type":"string","format":"","description":"The host name of the ping server in this data center","readOnly":true},"ipv4":{"type":"array","items":{"type":"string","format":""},"description":"List of ip address of ip version 4","readOnly":true,"deprecated":true},"ipv6":{"type":"array","items":{"type":"string","format":""},"description":"List of ip address of ip version 6","readOnly":true,"deprecated":true}},"additionalProperties":false}}}}
```

## The PingSiteDetail object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteDetail":{"type":"object","required":["continentId","continentName","countryId","countryName","dcLocationId","dcLocationName","regionName","beacons"],"properties":{"continentId":{"type":"integer","format":"integer","description":"The ID of the continent","readOnly":true},"continentName":{"type":"string","format":"","description":"The name of the continent","readOnly":true},"countryId":{"type":"integer","format":"integer","description":"The ID of the country","readOnly":true},"countryName":{"type":"string","format":"","description":"The name of the country","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","description":"The ID of the data center. Find all possible values from `GET /cloud/dcLocation`","readOnly":true},"dcLocationName":{"type":"string","format":"","description":"The name of the data center. Find all possible values from `GET /cloud/dcLocation`","readOnly":true},"regionName":{"type":"string","format":"","description":"The region name of the ping server in this data center","readOnly":true},"beacons":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteDetailBeacon"},"description":"The list of available beacons"}},"additionalProperties":false},"PingSiteDetailBeacon":{"type":"object","required":["hostName","state","ip"],"properties":{"hostName":{"type":"string","format":"","description":"The host name of the ping server in this data center","readOnly":true},"state":{"type":"string","format":"","description":"The state of the beacon","readOnly":true},"ip":{"type":"string","format":"","description":"The IP address of the beacon","readOnly":true}},"additionalProperties":false}}}}
```

## The PingSiteDetailBeacon object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteDetailBeacon":{"type":"object","required":["hostName","state","ip"],"properties":{"hostName":{"type":"string","format":"","description":"The host name of the ping server in this data center","readOnly":true},"state":{"type":"string","format":"","description":"The state of the beacon","readOnly":true},"ip":{"type":"string","format":"","description":"The IP address of the beacon","readOnly":true}},"additionalProperties":false}}}}
```

## The PingSiteLatencyConnectionModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyConnectionModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyFeaturesGeometryModel"}},"additionalProperties":false},"PingSiteLatencyPropertyModel":{"type":"object","required":["link","description"],"properties":{"link":{"type":"string","format":""},"description":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyFeaturesGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyCoordinatesModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyCoordinatesModel":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"string","format":""},"lng":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The PingSiteLatencyFeaturesGeometryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyFeaturesGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyFeaturesModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyFeaturesModel":{"type":"object","required":["ok","down","loss"],"properties":{"ok":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}},"down":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}},"loss":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}}},"additionalProperties":false},"PingSiteLatencyConnectionModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyFeaturesGeometryModel"}},"additionalProperties":false},"PingSiteLatencyPropertyModel":{"type":"object","required":["link","description"],"properties":{"link":{"type":"string","format":""},"description":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyFeaturesGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyModel":{"type":"object","required":["authStatus","authservice","authuser","responseTime","status","response","serverTime"],"properties":{"authStatus":{"type":"boolean"},"authservice":{"type":"boolean"},"authuser":{"type":"boolean"},"responseTime":{"type":"number","format":"float"},"status":{"type":"string","format":""},"response":{"$ref":"#/components/schemas/PingSiteLatencyResponseModel"},"serverTime":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyResponseModel":{"type":"object","required":["rpmRaw","features","routerPoints"],"properties":{"rpmRaw":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyRpmRawModel"}},"features":{"$ref":"#/components/schemas/PingSiteLatencyFeaturesModel"},"routerPoints":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyRouterPointModel"}}},"additionalProperties":false},"PingSiteLatencyRpmRawModel":{"type":"object","required":["link","latency5m","latency1d","latency1w","latency30d","jitter","packetloss5m","packetloss1d","packetloss1w","packetloss30d","sourceRegion","source","destinationRegion","destination"],"properties":{"link":{"type":"string","format":""},"latency5m":{"type":"string","format":""},"latency1d":{"type":"string","format":""},"latency1w":{"type":"string","format":""},"latency30d":{"type":"string","format":""},"jitter":{"type":"string","format":""},"packetloss5m":{"type":"string","format":""},"packetloss1d":{"type":"string","format":""},"packetloss1w":{"type":"string","format":""},"packetloss30d":{"type":"string","format":""},"sourceRegion":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PingSiteLatencyCoordinatesModel"},"destinationRegion":{"type":"boolean"},"destination":{"$ref":"#/components/schemas/PingSiteLatencyCoordinatesModel"}},"additionalProperties":false},"PingSiteLatencyCoordinatesModel":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"string","format":""},"lng":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyFeaturesModel":{"type":"object","required":["ok","down","loss"],"properties":{"ok":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}},"down":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}},"loss":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}}},"additionalProperties":false},"PingSiteLatencyConnectionModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyFeaturesGeometryModel"}},"additionalProperties":false},"PingSiteLatencyPropertyModel":{"type":"object","required":["link","description"],"properties":{"link":{"type":"string","format":""},"description":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyFeaturesGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}}},"additionalProperties":false},"PingSiteLatencyRouterPointModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyRouterPointGeometryModel"}},"additionalProperties":false},"PingSiteLatencyRouterPointGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"number","format":"float"}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyPropertyModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyPropertyModel":{"type":"object","required":["link","description"],"properties":{"link":{"type":"string","format":""},"description":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The PingSiteLatencyResponseModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyResponseModel":{"type":"object","required":["rpmRaw","features","routerPoints"],"properties":{"rpmRaw":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyRpmRawModel"}},"features":{"$ref":"#/components/schemas/PingSiteLatencyFeaturesModel"},"routerPoints":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyRouterPointModel"}}},"additionalProperties":false},"PingSiteLatencyRpmRawModel":{"type":"object","required":["link","latency5m","latency1d","latency1w","latency30d","jitter","packetloss5m","packetloss1d","packetloss1w","packetloss30d","sourceRegion","source","destinationRegion","destination"],"properties":{"link":{"type":"string","format":""},"latency5m":{"type":"string","format":""},"latency1d":{"type":"string","format":""},"latency1w":{"type":"string","format":""},"latency30d":{"type":"string","format":""},"jitter":{"type":"string","format":""},"packetloss5m":{"type":"string","format":""},"packetloss1d":{"type":"string","format":""},"packetloss1w":{"type":"string","format":""},"packetloss30d":{"type":"string","format":""},"sourceRegion":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PingSiteLatencyCoordinatesModel"},"destinationRegion":{"type":"boolean"},"destination":{"$ref":"#/components/schemas/PingSiteLatencyCoordinatesModel"}},"additionalProperties":false},"PingSiteLatencyCoordinatesModel":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"string","format":""},"lng":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyFeaturesModel":{"type":"object","required":["ok","down","loss"],"properties":{"ok":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}},"down":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}},"loss":{"type":"array","items":{"$ref":"#/components/schemas/PingSiteLatencyConnectionModel"}}},"additionalProperties":false},"PingSiteLatencyConnectionModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyFeaturesGeometryModel"}},"additionalProperties":false},"PingSiteLatencyPropertyModel":{"type":"object","required":["link","description"],"properties":{"link":{"type":"string","format":""},"description":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyFeaturesGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}}},"additionalProperties":false},"PingSiteLatencyRouterPointModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyRouterPointGeometryModel"}},"additionalProperties":false},"PingSiteLatencyRouterPointGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"number","format":"float"}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyRouterPointGeometryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyRouterPointGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"number","format":"float"}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyRouterPointModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyRouterPointModel":{"type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","format":""},"properties":{"$ref":"#/components/schemas/PingSiteLatencyPropertyModel"},"geometry":{"$ref":"#/components/schemas/PingSiteLatencyRouterPointGeometryModel"}},"additionalProperties":false},"PingSiteLatencyPropertyModel":{"type":"object","required":["link","description"],"properties":{"link":{"type":"string","format":""},"description":{"type":"string","format":""}},"additionalProperties":false},"PingSiteLatencyRouterPointGeometryModel":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","format":""},"coordinates":{"type":"array","items":{"type":"number","format":"float"}}},"additionalProperties":false}}}}
```

## The PingSiteLatencyRpmRawModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PingSiteLatencyRpmRawModel":{"type":"object","required":["link","latency5m","latency1d","latency1w","latency30d","jitter","packetloss5m","packetloss1d","packetloss1w","packetloss30d","sourceRegion","source","destinationRegion","destination"],"properties":{"link":{"type":"string","format":""},"latency5m":{"type":"string","format":""},"latency1d":{"type":"string","format":""},"latency1w":{"type":"string","format":""},"latency30d":{"type":"string","format":""},"jitter":{"type":"string","format":""},"packetloss5m":{"type":"string","format":""},"packetloss1d":{"type":"string","format":""},"packetloss1w":{"type":"string","format":""},"packetloss30d":{"type":"string","format":""},"sourceRegion":{"type":"boolean"},"source":{"$ref":"#/components/schemas/PingSiteLatencyCoordinatesModel"},"destinationRegion":{"type":"boolean"},"destination":{"$ref":"#/components/schemas/PingSiteLatencyCoordinatesModel"}},"additionalProperties":false},"PingSiteLatencyCoordinatesModel":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"string","format":""},"lng":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The PowerConsumptionPerDay object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PowerConsumptionPerDay":{"type":"object","required":["date","powerMeter","powerUsed"],"properties":{"date":{"type":"string","format":"","description":"The corresponding date","readOnly":true},"powerMeter":{"type":"string","format":"","description":"The power meter(kWh)","readOnly":true},"powerUsed":{"type":"string","format":"","description":"The used power(kWh)","readOnly":true}},"additionalProperties":false}}}}
```

## The PropertiesModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"PropertiesModel":{"type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"integer","description":"The heat value for the coordinate"}},"additionalProperties":false}}}}
```

## The QuoteColocation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"QuoteColocation":{"type":"object","required":["firstName","lastName","email","phone","rack","location","remarks"],"properties":{"firstName":{"type":"string","minLength":2,"maxLength":64,"format":"","description":"Customer's first name"},"lastName":{"type":"string","minLength":2,"maxLength":128,"format":"","description":"Customer's last name"},"companyName":{"type":"string","maxLength":120,"format":"","description":"Customer's company name (optional)"},"email":{"type":"string","maxLength":128,"format":"","description":"Customer's email address"},"phone":{"type":"string","minLength":5,"maxLength":15,"format":"","description":"Customer's phone number"},"rack":{"type":"string","format":"","description":"Rack space volume of interest"},"location":{"type":"string","format":"","description":"Location of interest"},"remarks":{"type":"string","format":"","description":"Quote remarks (the actual question and additional details)"}},"additionalProperties":false}}}}
```

## The RDns object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"RDns":{"type":"object","required":["hostname","ip"],"properties":{"hostname":{"type":"string","format":"","description":"The hostname"},"ip":{"type":"string","format":"","description":"The corresponding ip for the host","readOnly":true}},"additionalProperties":false}}}}
```

## The Service object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Service":{"type":"object","required":["id","service","amount"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the service","readOnly":true},"service":{"type":"string","format":"","description":"The name of the service","readOnly":true},"amount":{"type":"integer","format":"integer","description":"The amount of service the customer has","readOnly":true}},"additionalProperties":false}}}}
```

## The SessionAuthReq object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SessionAuthReq":{"type":"object","required":["requiresOtp","expiresAt","otpSessionExpiresAt"],"properties":{"requiresOtp":{"type":"boolean","description":"Indicates whether a 2FA One-Time Password token is required to complete the login."},"expiresAt":{"type":"integer","format":"integer","description":"Unix timestamp indicating when the window for 2FA authentication closes, 0 if not applicable."},"otpSessionExpiresAt":{"type":"integer","format":"integer","description":"If 2FA is active on your account, you must supply the one-time-password before this unix timestamp expires."}},"additionalProperties":false}}}}
```

## The SessionLogin object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SessionLogin":{"type":"object","required":["userName","password"],"properties":{"userName":{"type":"string","format":"","description":"User name"},"password":{"type":"string","format":"","description":"Password"},"rememberMe":{"type":"integer","format":"integer","description":"Remember me"}},"additionalProperties":false}}}}
```

## The SessionLoginOtp object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SessionLoginOtp":{"type":"object","required":["otp"],"properties":{"otp":{"type":"string","format":"","description":"6 digit One-Time Password"}},"additionalProperties":false}}}}
```

## The SessionUser object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SessionUser":{"type":"object","required":["userId","userName","email","firstName","lastName","gender","phone","accessLevel","validateEmail","isTrialAccount","trialAccountExpirationDate","requestIp","requestIpCountry","requestIpCountryCode","details","billingDetails"],"properties":{"userId":{"type":"integer","format":"integer","description":"Your user ID"},"userName":{"type":"string","format":"","description":"Your user name"},"email":{"type":"string","format":"","description":"Email"},"firstName":{"type":"string","format":"","description":"First name"},"lastName":{"type":"string","format":"","description":"Last name"},"gender":{"type":"string","format":"","description":"User gender"},"phone":{"type":"string","format":"","description":"Phone number"},"accessLevel":{"type":"integer","format":"integer","description":"0: Guest, 10: Regular logged in user, 20: Game Hosting management access"},"validateEmail":{"type":"integer","format":"integer","description":"Whether or not user email is validated","readOnly":true},"isTrialAccount":{"type":"integer","format":"integer","description":"Whether or not user is trial account","readOnly":true},"trialAccountExpirationDate":{"type":"string","format":"","description":"The expiration date of the trial account","readOnly":true},"requestIp":{"type":"string","format":"","description":"Request IP address"},"requestIpCountry":{"type":"string","format":"","description":"The GeoLocation country (ISO 3166) of the request IP address"},"requestIpCountryCode":{"type":"string","format":"","description":"The GeoLocation country code (ISO 3166 Alpha-2) of the request IP address"},"details":{"allOf":[{"$ref":"#/components/schemas/AccountDetails"}],"description":"User account details","readOnly":true},"billingDetails":{"allOf":[{"$ref":"#/components/schemas/AccountBillingDetails"}],"description":"User account billing details","readOnly":true}},"additionalProperties":false},"AccountDetails":{"type":"object","required":["accountType","firstName","lastName","address","streetNumber","zipCode","city","countryCode","emailAddress","unconfirmedEmail","emailAddressValidated","language","agreeDpa","isAllowedFlexMetal"],"properties":{"accountType":{"type":"integer","format":"integer","description":"Account type: 1 - consumer, 2 - business. Can only be updated by submitting a support ticket."},"companyName":{"type":"string","format":"","description":"Company name (for business accounts). Can only be updated by submitting a support ticket.","nullable":true},"vatNumber":{"type":"string","format":"","description":"VAT number (for business accounts). Can only be updated by submitting a support ticket.","nullable":true},"cocNumber":{"type":"string","format":"","description":"CoC number (only for Netherlands accounts). Can only be updated by submitting a support ticket.","nullable":true},"firstName":{"type":"string","format":"","description":"First name."},"lastName":{"type":"string","format":"","description":"Last name."},"address":{"type":"string","format":"","description":"Address - street name."},"streetNumber":{"type":"string","format":"","description":"House number"},"zipCode":{"type":"string","format":"","description":"ZIP / Post code."},"city":{"type":"string","format":"","description":"City."},"countryCode":{"type":"string","format":"","description":"Country code in ISO 3166-1 alpha-2 format."},"emailAddress":{"type":"string","format":"","description":"Email address","readOnly":true},"unconfirmedEmail":{"allOf":[{"$ref":"#/components/schemas/UnconfirmedEmail"}],"description":"Email address which is not confirmed yet","nullable":true,"readOnly":true},"emailAddressValidated":{"type":"integer","format":"integer","description":"Whether or not email address has been confirmed","nullable":true,"readOnly":true},"phoneNumber":{"type":"string","format":"","description":"Phone number. Either this or phoneNumberMobile is required","nullable":true},"phoneNumberMobile":{"type":"string","format":"","description":"Mobile phone number. Either this or phoneNumber is required","nullable":true},"language":{"type":"integer","format":"integer","description":"Preferred language: 0 - english, 1 - dutch"},"emailAddressAbuse":{"type":"string","format":"","description":"Email address for abuse emails","nullable":true},"newsletter":{"type":"integer","format":"integer","description":"Whether or not newsletter is subscribed to","nullable":true},"agreeToc":{"type":"integer","format":"integer","description":"Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.","nullable":true},"agreeAup":{"type":"integer","format":"integer","description":"Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.","nullable":true},"agreeDpa":{"type":"integer","format":"integer","description":"Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.","nullable":true},"isAllowedFlexMetal":{"type":"integer","format":"integer","description":"Whether or not the user is allowed to order flexmetal servers."}},"additionalProperties":false},"UnconfirmedEmail":{"type":"object","required":["email","expiresAt"],"properties":{"email":{"type":"string","format":"","description":"Email address which is not confirmed yet"},"expiresAt":{"type":"integer","format":"integer","description":"Expiry time of confirmation link","readOnly":true}},"additionalProperties":false,"nullable":true},"AccountBillingDetails":{"type":"object","required":["firstName","lastName","address","streetNumber","zipCode","city","countryCode","bundleInvoicesOfSameCategory","receivePaymentConfirmationsViaEmail","preferredPaymentMethod"],"properties":{"firstName":{"type":"string","format":"","description":"Billing first name."},"lastName":{"type":"string","format":"","description":"Billing last name."},"address":{"type":"string","format":"","description":"Billing address."},"streetNumber":{"type":"string","format":"","description":"Billing street number."},"zipCode":{"type":"string","format":"","description":"Billing ZIP code."},"city":{"type":"string","format":"","description":"Billing city."},"countryCode":{"type":"string","format":"","description":"Country code in ISO 3166-1 alpha-2 format."},"phoneNumber":{"type":"string","format":"","description":"Billing phone number. Either this or phoneNumberMobile is required.","nullable":true},"phoneNumberMobile":{"type":"string","format":"","description":"Billing mobile phone number. Either this or phoneNumber is required.","nullable":true},"emailAddressBilling":{"type":"string","format":"","description":"Email address for billing emails","nullable":true},"bundleInvoicesOfSameCategory":{"type":"integer","format":"integer","description":"Whether or not to bundle invoices of the same category"},"receivePaymentConfirmationsViaEmail":{"type":"integer","format":"integer","description":"Whether or not to send email confirmations via email"},"preferredPaymentMethod":{"type":"integer","format":"integer","description":"Preferred payment method"}},"additionalProperties":false}}}}
```

## The SlackSetting object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SlackSetting":{"type":"object","required":["id","name","webHookUrl","channel","userName"],"properties":{"id":{"type":"string","format":"","description":"The ID of the slack setting","readOnly":true},"name":{"type":"string","format":"","description":"The slack setting name"},"webHookUrl":{"type":"string","format":"","description":"The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)"},"channel":{"type":"string","format":"","description":"The slack setting channel name"},"userName":{"type":"string","format":"","description":"The slack setting channel username"}},"additionalProperties":false}}}}
```

## The SshKey object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SshKey":{"type":"object","required":["uuid","name","publicKey","createdAt"],"properties":{"uuid":{"type":"string","format":"","description":"SSH key UUID as specified in RFC 4122","readOnly":true},"name":{"type":"string","format":"","description":"SSH key name"},"publicKey":{"type":"string","format":"","description":"Public SSH key contents"},"createdAt":{"type":"integer","format":"integer","description":"SSH key createdAt","readOnly":true}},"additionalProperties":false}}}}
```

## The SwitchPortAdminState object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SwitchPortAdminState":{"type":"object","required":["serverId","networkInterfaceId","state"],"properties":{"serverId":{"type":"integer","format":"integer","description":"Server ID"},"networkInterfaceId":{"type":"integer","format":"integer","description":"Network Interface ID or graphUrl"},"state":{"type":"integer","format":"integer","description":"Port admin state"}},"additionalProperties":false}}}}
```

## The SwitchPortRateLimit object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SwitchPortRateLimit":{"type":"object","required":["serverId","networkInterfaceId","rateLimit"],"properties":{"serverId":{"type":"integer","format":"integer","description":"Server ID"},"networkInterfaceId":{"type":"integer","format":"integer","description":"Network Interface ID or graphUrl"},"rateLimit":{"type":"integer","format":"integer","description":"Port rate limit"}},"additionalProperties":false}}}}
```

## The SwitchPortSpeed object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"SwitchPortSpeed":{"type":"object","required":["serverId","networkInterfaceId","portSpeed"],"properties":{"serverId":{"type":"integer","format":"integer","description":"Server ID"},"networkInterfaceId":{"type":"integer","format":"integer","description":"Network Interface ID or graphUrl"},"portSpeed":{"type":"integer","format":"integer","description":"Port Speed"}},"additionalProperties":false}}}}
```

## The Ticket object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Ticket":{"type":"object","required":["title","categoryName","status"],"properties":{"id":{"type":"integer","format":"integer","description":"Ticket ID"},"hash":{"type":"string","format":"","description":"Ticket hash"},"readHash":{"type":"string","format":"","description":"Ticket read hash"},"title":{"type":"string","format":"","description":"Ticket title"},"categoryName":{"type":"string","format":"","description":"Ticket category name"},"priorityName":{"type":"string","format":"","description":"Ticket priority name"},"createdAt":{"type":"integer","format":"integer","description":"Ticket creation unix timestamp"},"updatedAt":{"type":"integer","format":"integer","description":"Ticket last update unix timestamp"},"clientLastRepliedAt":{"type":"integer","format":"integer","description":"Time at which the client last replied to the ticket"},"clientLastReadAt":{"type":"integer","format":"integer","description":"Time at which the client last read the ticket"},"status":{"type":"string","format":"","description":"Ticket status"},"numUserReplies":{"type":"integer","format":"integer","description":"Number of replies in ticket"},"replies":{"type":"array","items":{"$ref":"#/components/schemas/TicketReply"},"description":"All replies in this ticket"}},"additionalProperties":false},"TicketReply":{"type":"object","required":["id","title","fullUserName","content","createdAt","replyByI3d","attachments"],"properties":{"id":{"type":"integer","format":"integer","description":"Ticket reply ID"},"title":{"type":"string","format":"","description":"Reply title"},"fullUserName":{"type":"string","format":"","description":"Poster full name"},"content":{"type":"string","format":"","description":"Reply text"},"createdAt":{"type":"integer","format":"integer","description":"Reply creation unix timestamp"},"replyByI3d":{"type":"integer","format":"integer","description":"When 1, there has been a response from the helpdesk person","readOnly":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TicketReplyAttachment"},"description":"Reply attachments"}},"additionalProperties":false},"TicketReplyAttachment":{"type":"object","required":["id","name","mime","size","uploadedTime"],"properties":{"id":{"type":"integer","format":"integer","description":"Attachment ID"},"name":{"type":"string","format":"","description":"Attachment file name"},"mime":{"type":"string","format":"","description":"Attachment mime type"},"size":{"type":"integer","format":"integer","description":"Size in bytes"},"uploadedTime":{"type":"integer","format":"integer","description":"Attachment creation unix timestamp"}},"additionalProperties":false}}}}
```

## The TicketNew object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketNew":{"type":"object","required":["title","content","category","department","emailCc","emailTo"],"properties":{"title":{"type":"string","format":"","description":"Ticket title"},"content":{"type":"string","format":"","description":"Ticket content"},"category":{"type":"string","format":"","description":"Ticket category name, must be one of [GET /v3/tickets/categories](all#/tickets/categories)"},"department":{"type":"string","format":"","description":"Ticket department name"},"emailCc":{"type":"string","format":"","description":"Ticket's \"Carbon Copy\" email addresses in CSV format"},"emailTo":{"type":"string","format":"","description":"Ticket's destination email addresses in CSV format"},"attachmentIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"The IDs of attachments that have been uploaded through [POST /v3/tickets/attachment](all#/Tickets/createTicketsAttachment)"}},"additionalProperties":false}}}}
```

## The TicketNewAttachment object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketNewAttachment":{"type":"object","required":["attachment"],"properties":{"attachment":{"type":"object","additionalProperties":false,"description":"The attachment that is uploaded through your `multipart/form-data` request."}},"additionalProperties":false}}}}
```

## The TicketNewContact object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketNewContact":{"type":"object","required":["firstName","lastName","email","phone","title","category"],"properties":{"firstName":{"type":"string","minLength":2,"maxLength":64,"format":"","description":"Contact first name"},"lastName":{"type":"string","minLength":2,"maxLength":128,"format":"","description":"Contact last name"},"companyName":{"type":"string","maxLength":120,"format":"","description":"Customer's company name (optional)"},"email":{"type":"string","maxLength":128,"format":"","description":"Contact email address"},"phone":{"type":"string","minLength":5,"maxLength":15,"format":"","description":"Contact phone number"},"title":{"type":"string","minLength":2,"maxLength":250,"format":"","description":"Ticket title"},"content":{"type":"string","format":"","description":"Ticket content"},"category":{"type":"string","format":"","description":"Ticket category name, must be one of [GET /v3/tickets/categories](all#/tickets/categories)"}},"additionalProperties":false}}}}
```

## The TicketNewReply object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketNewReply":{"type":"object","required":["title","content"],"properties":{"title":{"type":"string","format":"","description":"Reply title"},"content":{"type":"string","format":"","description":"Reply content"},"attachmentIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"The IDs of attachments that have been uploaded through [POST /v3/tickets/attachment](all#/Tickets/createTicketsAttachment)"}},"additionalProperties":false}}}}
```

## The TicketReply object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketReply":{"type":"object","required":["id","title","fullUserName","content","createdAt","replyByI3d","attachments"],"properties":{"id":{"type":"integer","format":"integer","description":"Ticket reply ID"},"title":{"type":"string","format":"","description":"Reply title"},"fullUserName":{"type":"string","format":"","description":"Poster full name"},"content":{"type":"string","format":"","description":"Reply text"},"createdAt":{"type":"integer","format":"integer","description":"Reply creation unix timestamp"},"replyByI3d":{"type":"integer","format":"integer","description":"When 1, there has been a response from the helpdesk person","readOnly":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TicketReplyAttachment"},"description":"Reply attachments"}},"additionalProperties":false},"TicketReplyAttachment":{"type":"object","required":["id","name","mime","size","uploadedTime"],"properties":{"id":{"type":"integer","format":"integer","description":"Attachment ID"},"name":{"type":"string","format":"","description":"Attachment file name"},"mime":{"type":"string","format":"","description":"Attachment mime type"},"size":{"type":"integer","format":"integer","description":"Size in bytes"},"uploadedTime":{"type":"integer","format":"integer","description":"Attachment creation unix timestamp"}},"additionalProperties":false}}}}
```

## The TicketReplyAttachment object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketReplyAttachment":{"type":"object","required":["id","name","mime","size","uploadedTime"],"properties":{"id":{"type":"integer","format":"integer","description":"Attachment ID"},"name":{"type":"string","format":"","description":"Attachment file name"},"mime":{"type":"string","format":"","description":"Attachment mime type"},"size":{"type":"integer","format":"integer","description":"Size in bytes"},"uploadedTime":{"type":"integer","format":"integer","description":"Attachment creation unix timestamp"}},"additionalProperties":false}}}}
```

## The TicketUploadedAttachment object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TicketUploadedAttachment":{"type":"object","required":["attachmentId"],"properties":{"attachmentId":{"type":"integer","format":"integer","description":"The ID of the attachment that was uploaded through your `multipart/form-data` request."}},"additionalProperties":false}}}}
```

## The TimeTriggerRule object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TimeTriggerRule":{"type":"object","required":["operator","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET\n/v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"threshold":{"type":"integer","format":"integer","description":"The absolute amount of time the event should be triggered on in seconds"}},"additionalProperties":false}}}}
```

## The TrafficUsage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TrafficUsage":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency,  possible interval options are as follows\n- day","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/TrafficUsageData"},"description":"Contains the data object for the usage","readOnly":true}},"additionalProperties":false},"TrafficUsageData":{"type":"object","required":["timestamp","ingress","egress","sum"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The corresponding date","readOnly":true},"ingress":{"type":"string","format":"","description":"The incoming data usage in bytes","readOnly":true},"egress":{"type":"string","format":"","description":"The outgoing data usage in bytes","readOnly":true},"sum":{"type":"string","format":"","description":"The total used data in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The TrafficUsageData object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TrafficUsageData":{"type":"object","required":["timestamp","ingress","egress","sum"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The corresponding date","readOnly":true},"ingress":{"type":"string","format":"","description":"The incoming data usage in bytes","readOnly":true},"egress":{"type":"string","format":"","description":"The outgoing data usage in bytes","readOnly":true},"sum":{"type":"string","format":"","description":"The total used data in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The Trigger object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"Trigger":{"type":"object","required":["id","name","conditions","rules","actions","createdAt","changedAt","active"],"properties":{"id":{"type":"string","format":"","description":"ID of the the trigger","readOnly":true},"name":{"type":"string","format":"","description":"The name of the trigger"},"description":{"type":"string","format":"","description":"The description of the trigger"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/TriggerCondition"},"description":"The condition were the rule will be over"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/TriggerRule"},"description":"The rules that will fire the event"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/TriggerAction"},"description":"The action that will be fired based on the condition and the rule"},"createdAt":{"type":"integer","format":"integer","description":"The unix timestamp when the trigger has been created.","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"The unix timestamp when the trigger has been changed.","readOnly":true},"active":{"type":"integer","format":"integer","description":"Status of the trigger\n* 1 the trigger is enabled\n* 0 the trigger is disabled","readOnly":true}},"additionalProperties":false},"TriggerCondition":{"type":"object","required":["conditionId","conditionValues"],"properties":{"conditionId":{"type":"integer","format":"integer","description":"ID of the rule to be used, you can find the list on this endpoint [GET /v3/trigger/type/conditions](all#/Trigger/getTriggerTypeConditions)"},"conditionValues":{"type":"array","items":{"type":"string","format":""},"description":"ID of the object that belongs to the condition id chosen, use 0 for using all"}},"additionalProperties":false},"TriggerRule":{"type":"object","required":["ruleAction","ruleDataType","rule"],"properties":{"ruleAction":{"type":"integer","format":"integer","description":"The rule action you what to use, you can find the of on this endpoint [GET /v3/trigger/type/ruleActions](all#/Trigger/getTriggerTypeRuleActions)"},"ruleDataType":{"type":"integer","format":"integer","description":"The rule data type, on which type of data the rule should apply, you can find the of on this endpoint [GET /v3/trigger/type/ruleDataTypes](all#/Trigger/getTriggerTypeRuleDataTypes)"},"rule":{"anyOf":[{"$ref":"#/components/schemas/MemoryTriggerRule"},{"$ref":"#/components/schemas/CPUTriggerRule"},{"$ref":"#/components/schemas/TimeTriggerRule"}],"description":"The rule that you want to trigger the event on"}},"additionalProperties":false},"MemoryTriggerRule":{"type":"object","required":["operator","triggerWindow","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET /v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"triggerWindow":{"type":"integer","format":"integer","description":"The time window for a rule, time will be in seconds"},"threshold":{"type":"integer","format":"integer","description":"The amount of memory were the event should be triggered on in MB"}},"additionalProperties":false},"CPUTriggerRule":{"type":"object","required":["operator","triggerWindow","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET /v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"triggerWindow":{"type":"integer","format":"integer","description":"The time window for a rule, time will be in seconds"},"threshold":{"type":"integer","format":"integer","description":"The percentage of cpu (between 0 and 100%) usage were the event should be triggered on"}},"additionalProperties":false},"TimeTriggerRule":{"type":"object","required":["operator","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET\n/v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"threshold":{"type":"integer","format":"integer","description":"The absolute amount of time the event should be triggered on in seconds"}},"additionalProperties":false},"TriggerAction":{"type":"object","required":["action"],"properties":{"action":{"type":"integer","format":"integer","description":"The action used for this trigger, you can find the list on this endpoint [GET /v3/trigger/type/actions](all#/Trigger/getTriggerTypeActions)"},"actionParameters":{"allOf":[{"$ref":"#/components/schemas/ApplicationInstanceStopMethod"}],"description":"The action parameters that are used to fire the trigger"}},"additionalProperties":false},"ApplicationInstanceStopMethod":{"type":"object","properties":{"methodId":{"type":"integer","format":"integer","description":"Stop method type, list of types can be found in: [GET /v3/application/stopMethod](game-publisher#/Application/getApplicationStopMethods)"},"timeout":{"type":"integer","format":"integer","description":"Stop method timeout in seconds, default value is 1800 seconds."}},"additionalProperties":false}}}}
```

## The TriggerAction object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TriggerAction":{"type":"object","required":["action"],"properties":{"action":{"type":"integer","format":"integer","description":"The action used for this trigger, you can find the list on this endpoint [GET /v3/trigger/type/actions](all#/Trigger/getTriggerTypeActions)"},"actionParameters":{"allOf":[{"$ref":"#/components/schemas/ApplicationInstanceStopMethod"}],"description":"The action parameters that are used to fire the trigger"}},"additionalProperties":false},"ApplicationInstanceStopMethod":{"type":"object","properties":{"methodId":{"type":"integer","format":"integer","description":"Stop method type, list of types can be found in: [GET /v3/application/stopMethod](game-publisher#/Application/getApplicationStopMethods)"},"timeout":{"type":"integer","format":"integer","description":"Stop method timeout in seconds, default value is 1800 seconds."}},"additionalProperties":false}}}}
```

## The TriggerCondition object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TriggerCondition":{"type":"object","required":["conditionId","conditionValues"],"properties":{"conditionId":{"type":"integer","format":"integer","description":"ID of the rule to be used, you can find the list on this endpoint [GET /v3/trigger/type/conditions](all#/Trigger/getTriggerTypeConditions)"},"conditionValues":{"type":"array","items":{"type":"string","format":""},"description":"ID of the object that belongs to the condition id chosen, use 0 for using all"}},"additionalProperties":false}}}}
```

## The TriggerRule object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TriggerRule":{"type":"object","required":["ruleAction","ruleDataType","rule"],"properties":{"ruleAction":{"type":"integer","format":"integer","description":"The rule action you what to use, you can find the of on this endpoint [GET /v3/trigger/type/ruleActions](all#/Trigger/getTriggerTypeRuleActions)"},"ruleDataType":{"type":"integer","format":"integer","description":"The rule data type, on which type of data the rule should apply, you can find the of on this endpoint [GET /v3/trigger/type/ruleDataTypes](all#/Trigger/getTriggerTypeRuleDataTypes)"},"rule":{"anyOf":[{"$ref":"#/components/schemas/MemoryTriggerRule"},{"$ref":"#/components/schemas/CPUTriggerRule"},{"$ref":"#/components/schemas/TimeTriggerRule"}],"description":"The rule that you want to trigger the event on"}},"additionalProperties":false},"MemoryTriggerRule":{"type":"object","required":["operator","triggerWindow","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET /v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"triggerWindow":{"type":"integer","format":"integer","description":"The time window for a rule, time will be in seconds"},"threshold":{"type":"integer","format":"integer","description":"The amount of memory were the event should be triggered on in MB"}},"additionalProperties":false},"CPUTriggerRule":{"type":"object","required":["operator","triggerWindow","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET /v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"triggerWindow":{"type":"integer","format":"integer","description":"The time window for a rule, time will be in seconds"},"threshold":{"type":"integer","format":"integer","description":"The percentage of cpu (between 0 and 100%) usage were the event should be triggered on"}},"additionalProperties":false},"TimeTriggerRule":{"type":"object","required":["operator","threshold"],"properties":{"operator":{"type":"integer","format":"integer","description":"The operator used for this rule, you can find the list on this endpoint [GET\n/v3/trigger/type/operators](all#/Trigger/getTriggerTypeOperators)"},"threshold":{"type":"integer","format":"integer","description":"The absolute amount of time the event should be triggered on in seconds"}},"additionalProperties":false}}}}
```

## The TriggerSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TriggerSummary":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the type","readOnly":true},"name":{"type":"string","format":"","description":"The name of the trigger"},"description":{"type":"string","format":"","description":"The description of the trigger"}},"additionalProperties":false}}}}
```

## The TriggerType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"TriggerType":{"type":"object","required":["id","description"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the type","readOnly":true},"description":{"type":"string","format":"","description":"The description of the type","readOnly":true}},"additionalProperties":false}}}}
```

## The UnconfirmedEmail object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"UnconfirmedEmail":{"type":"object","required":["email","expiresAt"],"properties":{"email":{"type":"string","format":"","description":"Email address which is not confirmed yet"},"expiresAt":{"type":"integer","format":"integer","description":"Expiry time of confirmation link","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The UpLink object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"UpLink":{"type":"object","required":["side","uplinkId"],"properties":{"side":{"type":"string","format":"","description":"Side of the uplink\nFollowing will be possible values for sides uplink:\n* A\n* Z","readOnly":true},"uplinkId":{"type":"integer","format":"integer","description":"Up Link ID","readOnly":true}},"additionalProperties":false}}}}
```

## The UserRemoteInformation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"UserRemoteInformation":{"type":"object","required":["ipAddressFromServerVariable","ipAddressFromRequest","xForwardFor","xForwardHost","userAgent"],"properties":{"ipAddressFromServerVariable":{"type":"string","format":"","description":"The ip address for which you wish to fetch the data"},"ipAddressFromRequest":{"type":"string","format":"","description":"The ip address for which you wish to fetch the data"},"xForwardFor":{"type":"string","format":"","description":"The xForwardFor for which you wish to fetch the data","readOnly":true},"xForwardHost":{"type":"string","format":"","description":"The xForwardHost for which you wish to fetch the data","readOnly":true},"userAgent":{"type":"string","format":"","description":"The user agent for which you wish to fetch the data"}},"additionalProperties":false}}}}
```

## The WifiCredential object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net Endpoints","version":"3.0.0"},"components":{"schemas":{"WifiCredential":{"type":"object","required":["networkName","userName","password"],"properties":{"networkName":{"type":"string","format":"","description":"Wifi SSID","readOnly":true},"userName":{"type":"string","format":"","description":"Wifi user-name","readOnly":true},"password":{"type":"string","format":"","description":"Wifi Password","readOnly":true}},"additionalProperties":false}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.i3d.net/api-references/general/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.