Colocation

Colocation service endpoints

Get list of all colocated servers

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringRequired

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

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of the colocation service

namestringOptional

The name of the colocation service

dateStartstringRead-onlyRequired

Contract start date

dateEndstringRead-onlyRequired

The date until which the service is paid

dateCancelledstringRead-onlyRequired

Contract cancel date if contract is cancelled

dateEndContractstringRead-onlyRequired

Contract end date

contractPeriodinteger · integerRead-onlyRequired

The duration of the contract in months

extendPeriodinteger · integerRead-onlyRequired

The extended period of the contract in months

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

purchaseOrderstringOptional

The order-name to which the server belongs

paymentTerminteger · integerRead-onlyRequired

The duration in which the invoice has to be paid after receiving.

pricePerMonthstringRead-onlyRequired

The price of this colocated server per month in cents

pricePerTbOverusestringRead-onlyRequired

The price of traffic overuse in cents (per TB) (see currencyId for currency)

currencyIdinteger · integerRead-onlyRequired

The currency in which the various 'price' fields are:

0: EURO
1: USD
9: YEN

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

1: unmetered connection
2: measured in TB per month
3: measured in mbit 95th percentile

bandwidthContractualinteger · integerRead-onlyRequired

The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise

trafficSuminteger · integerRead-onlyRequired

The total used traffic (Mbit or GB, incoming + outgoing)

trafficSumMonthMbitinteger · integerRead-onlyRequired

The total used traffic (Mbit) for 95th percentile

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB)

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB)

powerMaxAmperestringRead-onlyRequired

Contractual maximum usable amperage

powerKwhPricestringRead-onlyRequired

The power price per kWh in cents

powerMeterinteger · integerRead-onlyRequired

The current power meter(kWh)

unlimitedIngressinteger · integerRead-onlyRequired

Does the service have free incoming traffic?

400

Bad Request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/colocation

GET /v3/colocation HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
RANGED-DATA: text
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "datacenter": {
      "address": {
        "name": "text",
        "address": "text",
        "zipCode": "text",
        "city": "text",
        "country": "text"
      },
      "contact": {
        "phoneNumber": "text",
        "emergencyPhoneNumber": "text",
        "faxNumber": "text",
        "emailAddress": "text"
      },
      "wifi": {
        "networkName": "text",
        "userName": "text",
        "password": "text"
      }
    },
    "rack": {
      "rack": "text",
      "rentedUnits": 1
    },
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "purchaseOrder": "text",
    "paymentTerm": 1,
    "pricePerMonth": "text",
    "pricePerTbOveruse": "text",
    "currencyId": 1,
    "bandwidthBillingType": 1,
    "bandwidthContractual": 1,
    "trafficSum": 1,
    "trafficSumMonthMbit": 1,
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "powerMaxAmpere": "text",
    "powerKwhPrice": "text",
    "powerMeter": 1,
    "powerSumHistory": [
      {
        "date": "text",
        "powerMeter": "text",
        "powerUsed": "text"
      }
    ],
    "network": [
      {
        "vlanId": 1,
        "ipRange": [
          {
            "network": "text",
            "netmask": "text",
            "prefix": "text",
            "gateway": "text",
            "vrrp1": "text",
            "vrrp2": "text",
            "rDns": [
              {
                "hostname": "text",
                "ip": "text"
              }
            ]
          }
        ],
        "ipRangeCustom": [
          {
            "networkStart": "text",
            "networkEnd": "text",
            "gateway": "text",
            "vrrp1": "text",
            "vrrp2": "text",
            "rDns": [
              {
                "hostname": "text",
                "ip": "text"
              }
            ]
          }
        ]
      }
    ],
    "uplinks": [
      {
        "uplinkId": 1,
        "aggregate": true
      }
    ],
    "unlimitedIngress": 1
  }
]

Get the colocated server by ID

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of the colocation service

namestringOptional

The name of the colocation service

dateStartstringRead-onlyRequired

Contract start date

dateEndstringRead-onlyRequired

The date until which the service is paid

dateCancelledstringRead-onlyRequired

Contract cancel date if contract is cancelled

dateEndContractstringRead-onlyRequired

Contract end date

contractPeriodinteger · integerRead-onlyRequired

The duration of the contract in months

extendPeriodinteger · integerRead-onlyRequired

The extended period of the contract in months

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

purchaseOrderstringOptional

The order-name to which the server belongs

paymentTerminteger · integerRead-onlyRequired

The duration in which the invoice has to be paid after receiving.

pricePerMonthstringRead-onlyRequired

The price of this colocated server per month in cents

pricePerTbOverusestringRead-onlyRequired

The price of traffic overuse in cents (per TB) (see currencyId for currency)

currencyIdinteger · integerRead-onlyRequired

The currency in which the various 'price' fields are:

0: EURO
1: USD
9: YEN

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

1: unmetered connection
2: measured in TB per month
3: measured in mbit 95th percentile

bandwidthContractualinteger · integerRead-onlyRequired

The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise

trafficSuminteger · integerRead-onlyRequired

The total used traffic (Mbit or GB, incoming + outgoing)

trafficSumMonthMbitinteger · integerRead-onlyRequired

The total used traffic (Mbit) for 95th percentile

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB)

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB)

powerMaxAmperestringRead-onlyRequired

Contractual maximum usable amperage

powerKwhPricestringRead-onlyRequired

The power price per kWh in cents

powerMeterinteger · integerRead-onlyRequired

The current power meter(kWh)

unlimitedIngressinteger · integerRead-onlyRequired

Does the service have free incoming traffic?

403

Invalid credentials

404

Invalid colocationId

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}

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

[
  {
    "id": 1,
    "name": "text",
    "datacenter": {
      "address": {
        "name": "text",
        "address": "text",
        "zipCode": "text",
        "city": "text",
        "country": "text"
      },
      "contact": {
        "phoneNumber": "text",
        "emergencyPhoneNumber": "text",
        "faxNumber": "text",
        "emailAddress": "text"
      },
      "wifi": {
        "networkName": "text",
        "userName": "text",
        "password": "text"
      }
    },
    "rack": {
      "rack": "text",
      "rentedUnits": 1
    },
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "purchaseOrder": "text",
    "paymentTerm": 1,
    "pricePerMonth": "text",
    "pricePerTbOveruse": "text",
    "currencyId": 1,
    "bandwidthBillingType": 1,
    "bandwidthContractual": 1,
    "trafficSum": 1,
    "trafficSumMonthMbit": 1,
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "powerMaxAmpere": "text",
    "powerKwhPrice": "text",
    "powerMeter": 1,
    "powerSumHistory": [
      {
        "date": "text",
        "powerMeter": "text",
        "powerUsed": "text"
      }
    ],
    "network": [
      {
        "vlanId": 1,
        "ipRange": [
          {
            "network": "text",
            "netmask": "text",
            "prefix": "text",
            "gateway": "text",
            "vrrp1": "text",
            "vrrp2": "text",
            "rDns": [
              {
                "hostname": "text",
                "ip": "text"
              }
            ]
          }
        ],
        "ipRangeCustom": [
          {
            "networkStart": "text",
            "networkEnd": "text",
            "gateway": "text",
            "vrrp1": "text",
            "vrrp2": "text",
            "rDns": [
              {
                "hostname": "text",
                "ip": "text"
              }
            ]
          }
        ]
      }
    ],
    "uplinks": [
      {
        "uplinkId": 1,
        "aggregate": true
      }
    ],
    "unlimitedIngress": 1
  }
]

Update the colocated server by ID

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

Body

idinteger · integerRead-onlyRequired

The ID of the colocation service

namestringOptional

The name of the colocation service

dateStartstringRead-onlyRequired

Contract start date

dateEndstringRead-onlyRequired

The date until which the service is paid

dateCancelledstringRead-onlyRequired

Contract cancel date if contract is cancelled

dateEndContractstringRead-onlyRequired

Contract end date

contractPeriodinteger · integerRead-onlyRequired

The duration of the contract in months

extendPeriodinteger · integerRead-onlyRequired

The extended period of the contract in months

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

purchaseOrderstringOptional

The order-name to which the server belongs

paymentTerminteger · integerRead-onlyRequired

The duration in which the invoice has to be paid after receiving.

pricePerMonthstringRead-onlyRequired

The price of this colocated server per month in cents

pricePerTbOverusestringRead-onlyRequired

The price of traffic overuse in cents (per TB) (see currencyId for currency)

currencyIdinteger · integerRead-onlyRequired

The currency in which the various 'price' fields are:

0: EURO
1: USD
9: YEN

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

1: unmetered connection
2: measured in TB per month
3: measured in mbit 95th percentile

bandwidthContractualinteger · integerRead-onlyRequired

The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise

trafficSuminteger · integerRead-onlyRequired

The total used traffic (Mbit or GB, incoming + outgoing)

trafficSumMonthMbitinteger · integerRead-onlyRequired

The total used traffic (Mbit) for 95th percentile

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB)

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB)

powerMaxAmperestringRead-onlyRequired

Contractual maximum usable amperage

powerKwhPricestringRead-onlyRequired

The power price per kWh in cents

powerMeterinteger · integerRead-onlyRequired

The current power meter(kWh)

unlimitedIngressinteger · integerRead-onlyRequired

Does the service have free incoming traffic?

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of the colocation service

namestringOptional

The name of the colocation service

dateStartstringRead-onlyRequired

Contract start date

dateEndstringRead-onlyRequired

The date until which the service is paid

dateCancelledstringRead-onlyRequired

Contract cancel date if contract is cancelled

dateEndContractstringRead-onlyRequired

Contract end date

contractPeriodinteger · integerRead-onlyRequired

The duration of the contract in months

extendPeriodinteger · integerRead-onlyRequired

The extended period of the contract in months

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

purchaseOrderstringOptional

The order-name to which the server belongs

paymentTerminteger · integerRead-onlyRequired

The duration in which the invoice has to be paid after receiving.

pricePerMonthstringRead-onlyRequired

The price of this colocated server per month in cents

pricePerTbOverusestringRead-onlyRequired

The price of traffic overuse in cents (per TB) (see currencyId for currency)

currencyIdinteger · integerRead-onlyRequired

The currency in which the various 'price' fields are:

0: EURO
1: USD
9: YEN

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

1: unmetered connection
2: measured in TB per month
3: measured in mbit 95th percentile

bandwidthContractualinteger · integerRead-onlyRequired

The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise

trafficSuminteger · integerRead-onlyRequired

The total used traffic (Mbit or GB, incoming + outgoing)

trafficSumMonthMbitinteger · integerRead-onlyRequired

The total used traffic (Mbit) for 95th percentile

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB)

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB)

powerMaxAmperestringRead-onlyRequired

Contractual maximum usable amperage

powerKwhPricestringRead-onlyRequired

The power price per kWh in cents

powerMeterinteger · integerRead-onlyRequired

The current power meter(kWh)

unlimitedIngressinteger · integerRead-onlyRequired

Does the service have free incoming traffic?

403

Invalid credentials

404

Invalid colocationId

500

Internal Server Error

application/json

put

/v3/colocation/{colocationId}

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

{
  "name": "text",
  "purchaseOrder": "text"
}

[
  {
    "id": 1,
    "name": "text",
    "datacenter": {
      "address": {
        "name": "text",
        "address": "text",
        "zipCode": "text",
        "city": "text",
        "country": "text"
      },
      "contact": {
        "phoneNumber": "text",
        "emergencyPhoneNumber": "text",
        "faxNumber": "text",
        "emailAddress": "text"
      },
      "wifi": {
        "networkName": "text",
        "userName": "text",
        "password": "text"
      }
    },
    "rack": {
      "rack": "text",
      "rentedUnits": 1
    },
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "purchaseOrder": "text",
    "paymentTerm": 1,
    "pricePerMonth": "text",
    "pricePerTbOveruse": "text",
    "currencyId": 1,
    "bandwidthBillingType": 1,
    "bandwidthContractual": 1,
    "trafficSum": 1,
    "trafficSumMonthMbit": 1,
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "powerMaxAmpere": "text",
    "powerKwhPrice": "text",
    "powerMeter": 1,
    "powerSumHistory": [
      {
        "date": "text",
        "powerMeter": "text",
        "powerUsed": "text"
      }
    ],
    "network": [
      {
        "vlanId": 1,
        "ipRange": [
          {
            "network": "text",
            "netmask": "text",
            "prefix": "text",
            "gateway": "text",
            "vrrp1": "text",
            "vrrp2": "text",
            "rDns": [
              {
                "hostname": "text",
                "ip": "text"
              }
            ]
          }
        ],
        "ipRangeCustom": [
          {
            "networkStart": "text",
            "networkEnd": "text",
            "gateway": "text",
            "vrrp1": "text",
            "vrrp2": "text",
            "rDns": [
              {
                "hostname": "text",
                "ip": "text"
              }
            ]
          }
        ]
      }
    ],
    "uplinks": [
      {
        "uplinkId": 1,
        "aggregate": true
      }
    ],
    "unlimitedIngress": 1
  }
]

Get all the invoices for a specific colocated service

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated service to fetch invoices for

Header parameters

RANGED-DATAstringOptional

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

Responses

200

application/json

idstringRead-onlyRequired

The ID of the invoice

creationDateinteger · integerRead-onlyRequired

The date the invoice was created

dueDateinteger · integerRead-onlyRequired

The due date of the invoice

invoiceNumberstringRead-onlyRequired

The number of the invoice

invoiceHashstringRead-onlyRequired

A unique hash for this invoice

descriptionstringRequired

The description of the invoice

currencystringRequired

The currency that is being used

currencySignstringRequired

The currency sign that is being used

amountIncVATstringRequired

The amount of the invoice with VAT in cents

amountExclVATstringRequired

The amount of the invoice without VAT in cents

paymentStatusinteger · integerRequired

The payment status

paymentDateinteger · integerRequired

The timestamp that the invoice was paid, if paid

isCreditinteger · integerRequired

If this field is 1 it means that invoice is a credit invoice

remainingAmountstringRequired

The remaining amount of invoice

totalPaidAmountstringRequired

The total paid amount of invoice

403

Invalid credentials

404

Invalid colocation ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/invoice

GET /v3/colocation/{colocationId}/invoice HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "creationDate": 1,
    "dueDate": 1,
    "invoiceNumber": "text",
    "invoiceHash": "text",
    "description": "text",
    "currency": "text",
    "currencySign": "text",
    "amountIncVAT": "text",
    "amountExclVAT": "text",
    "paymentStatus": 1,
    "paymentDate": 1,
    "isCredit": 1,
    "remainingAmount": "text",
    "totalPaidAmount": "text"
  }
]

Get all the PDUs for a specific colocated service

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated service to fetch PDUs for

Responses

200

application/json

idinteger · integerRead-onlyRequired

The id of feed

namestringRequired

The feed name

serialstringRequired

The serial number

updatedAtinteger · integerRequired

The last update time

inputFeedTypestringRequired

The feed type

outletsinteger · integerRequired

The number of outlets on this pdu

phasesinteger · integerRequired

The number of phases that this pdu supports

powerMeterinteger · integerRequired

The last registered counter value

powerFactornumber · floatRequired

The total power factor

amperagenumber · floatRequired

The total amperage supported by pdu

peakAmperagenumber · floatRequired

The peak amperage

voltagenumber · floatRequired

The total actual voltage

minVoltagenumber · floatRequired

The total min voltage

403

Invalid credentials

404

Invalid colocation ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/pdu

GET /v3/colocation/{colocationId}/pdu HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "serial": "text",
    "updatedAt": 1,
    "inputFeedType": "text",
    "outlets": 1,
    "phases": 1,
    "powerMeter": 1,
    "powerFactor": 1,
    "amperage": 1,
    "peakAmperage": 1,
    "voltage": 1,
    "minVoltage": 1,
    "conduits": [
      {
        "conduitName": "text",
        "powerMeter": 1,
        "amperage": 1,
        "peakAmperage": 1
      }
    ]
  }
]

Get the traffic usage data for the last day

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Query parameters

startTimeintegerOptional

Start unix timestamp

endTimeintegerOptional

End unix timestamp

Responses

200

application/json

unitstringRead-onlyRequired

Unit of data frequency, possible interval options are as follows

403

Invalid credentials

404

Invalid colocation ID or uplink ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/network/usage/{upLinkId}/raw

GET /v3/colocation/{colocationId}/network/usage/{upLinkId}/raw HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "unit": "text",
    "data": [
      {
        "timestamp": 1,
        "ingress": "text",
        "egress": "text",
        "sum": "text"
      }
    ]
  }
]

Get the traffic usage graph (last year)

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid colocation ID or uplink ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/year

GET /v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/year HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get the traffic usage graph (last 30 days)

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid colocation ID or uplink ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/month

GET /v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/month HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get the traffic usage graph (last 7 days)

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid colocation ID or uplink ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/week

GET /v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/week HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get the traffic usage graph (last 24 hours)

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid colocation ID or uplink ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/day

GET /v3/colocation/{colocationId}/network/usage/{upLinkId}/graph/day HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get all the alerts linked to the colocated server

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to get the alerts for

Responses

200

application/json

idinteger · integerRead-onlyRequired

Colocation alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

403

Invalid credentials

404

Invalid colocation ID

500

Internal Server Error

application/json

get

/v3/colocation/{colocationId}/alert

GET /v3/colocation/{colocationId}/alert HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "percentage": 1,
    "sendMail": 1,
    "sendTicket": 1,
    "triggered": 1,
    "createdAt": 1
  }
]

Create alert for the colocated server

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server to create an alert for

Body

idinteger · integerRead-onlyRequired

Colocation alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

Responses

200

application/json

idinteger · integerRead-onlyRequired

Colocation alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

403

Invalid credentials

404

Invalid colocation ID

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/colocation/{colocationId}/alert

POST /v3/colocation/{colocationId}/alert HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "percentage": 1,
  "sendMail": 1,
  "sendTicket": 1
}

[
  {
    "id": 1,
    "percentage": 1,
    "sendMail": 1,
    "sendTicket": 1,
    "triggered": 1,
    "createdAt": 1
  }
]

Update colocated server alert

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server that the alert belongs to

colocationAlertIdintegerRequired

ID of the host alert to update

Body

idinteger · integerRead-onlyRequired

Colocation alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

Responses

200

application/json

idinteger · integerRead-onlyRequired

Colocation alert ID

percentageinteger · integerRequired

At what percentage of bandwidth usage to trigger the alert

sendMailinteger · integerRequired

Will send an email notification when alert is triggered

sendTicketinteger · integerRequired

WIll create a ticket notification when alert is triggered

triggeredinteger · integerRead-onlyRequired

UNIX timestamp of the last time the alert was triggered

createdAtinteger · integerRead-onlyRequired

UNIX timestamp of the time the alert was created

403

Invalid credentials

404

Invalid colocation ID or alert ID

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/colocation/{colocationId}/alert/{colocationAlertId}

PUT /v3/colocation/{colocationId}/alert/{colocationAlertId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "percentage": 1,
  "sendMail": 1,
  "sendTicket": 1
}

[
  {
    "id": 1,
    "percentage": 1,
    "sendMail": 1,
    "sendTicket": 1,
    "triggered": 1,
    "createdAt": 1
  }
]

Delete colocated server alert

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server that the alert belongs to

colocationAlertIdintegerRequired

ID of the alert to delete

Responses

204

No Content

403

Invalid credentials

404

Invalid colocated server ID or alert ID

500

Internal Server Error

application/json

delete

/v3/colocation/{colocationId}/alert/{colocationAlertId}

DELETE /v3/colocation/{colocationId}/alert/{colocationAlertId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Cancel the colocated server

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocated server that the cancellation should applied to

Responses

204

No Content

403

Invalid credentials

404

Invalid colocated server ID

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/colocation/{colocationId}/cancel

PUT /v3/colocation/{colocationId}/cancel HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Revert the cancellation of a colocated server

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the cancelled colocated server that should be reverted

Responses

204

No Content

403

Invalid credentials

404

Invalid colocated server ID

422

Unable to revert cancellation of colocated server

500

Internal Server Error

application/json

put

/v3/colocation/{colocationId}/cancel/revert

PUT /v3/colocation/{colocationId}/cancel/revert HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Set RDNS hostname for IP

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

colocationIdintegerRequired

ID of the colocation-service to which IP address belongs to

ipAddressstringRequired

IP address to set RDNS entry for

Body

hostnamestringRequired

The hostname

ipstringRead-onlyRequired

The corresponding ip for the host

Responses

204

No Content

403

Invalid credentials

404

Invalid colocation-service ID or IP address

500

Internal Server Error

application/json

put

/v3/colocation/{colocationId}/network/rdns/{ipAddress}

PUT /v3/colocation/{colocationId}/network/rdns/{ipAddress} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "hostname": "text"
}

No content

Get list of all colocation access

get

Authorizations

PRIVATE-TOKENstringRequired

Query parameters

statusstringOptional

Example /v3/colocation/access?status=revoked

Header parameters

RANGED-DATAstringOptional

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

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of colocation access request

visitorIdinteger · integerRequired

The ID of the user

datacenterIdinteger · integer · nullableOptional

The ID of data center

dateverifiedstring · nullableOptional

The date when the user was verified

dateonliststring · nullableOptional

The date when the user was added to the access list

dateoffliststring · nullableOptional

The date when the user was removed from the access list

emailstringRequired

The e-mail address of the visitor

mobilestringRequired

The mobile phone number of the visitor

firstNamestringRequired

The first name of the visitor

lastNamestringRequired

The last name of the visitor

birthDatestringRequired

The birth date of the user. The format is YYYY-MM-DD

companyNamestring · nullableOptional

The company name of the visitor

citystring · nullableOptional

The city of the visitor

countryEnstringRead-onlyRequired

The country name of the visitor

adminNotesReadOnlystring · nullableOptional

Notes for admins

checkedstring · nullableOptional

Was the user checked?

createdByinteger · integerRead-onlyRequired

ID of user creator

newEntryinteger · integerRead-onlyRequired

Is this a new entry

temporaryAccessinteger · integer · nullableOptional

temporaryAccess If this field is set to 1, then has the visitor a temporary access

fingerPrintIdinteger · integer · nullableOptional

The print ID from Syntegro system

printMadestring · nullableOptional

Was the print made

visitRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can add a temporary access for other visitor

permanentRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can request a permanent access for other visitor

syntegroEmployeeCodestring · nullableOptional

The Syntegro employee code of visitor

statusstringRead-onlyRequired

The status of the visitor (granted, pending, denied, revoked, suspended)

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

get

/v3/colocation/access

GET /v3/colocation/access HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "visitorId": 1,
    "datacenterId": 1,
    "dateverified": "text",
    "dateonlist": "text",
    "dateofflist": "text",
    "email": "text",
    "mobile": "text",
    "firstName": "text",
    "lastName": "text",
    "birthDate": "text",
    "companyName": "text",
    "city": "text",
    "countryEn": "text",
    "colocatedAccessServers": [
      {
        "coloserverId": 1,
        "rackname": "text"
      }
    ],
    "adminNotesReadOnly": "text",
    "accountDocument": [
      {
        "id": 1,
        "documentType": 1,
        "documentNumber": "text",
        "documentExpiration": "text"
      }
    ],
    "checked": "text",
    "createdBy": 1,
    "newEntry": 1,
    "temporaryAccess": 1,
    "fingerPrintId": 1,
    "printMade": "text",
    "visitRequester": 1,
    "permanentRequester": 1,
    "syntegroEmployeeCode": "text",
    "status": "text"
  }
]

Create a new colocation access request

post

Authorizations

PRIVATE-TOKENstringRequired

Body

idinteger · integerRead-onlyRequired

The ID of colocation access request

visitorIdinteger · integerOptional

The ID of the visitor

emailstringRequired

The e-mail address of the visitor

mobilestringRequired

The mobile phone number of the visitor

firstNamestringRequired

The first name of the visitor

lastNamestringRequired

The last name of the visitor

birthDatestringRequired

The birth date of the visitor

companyNamestringRequired

The company name of visitor

temporaryAccessinteger · integer · nullableOptional

If this field is set to 1, then the visitor has a temporary access

visitRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can add a temporary access for other visitor

permanentRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can request a permanent access for other visitor

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of colocation access request

visitorIdinteger · integerRequired

The ID of the user

datacenterIdinteger · integer · nullableOptional

The ID of data center

dateverifiedstring · nullableOptional

The date when the user was verified

dateonliststring · nullableOptional

The date when the user was added to the access list

dateoffliststring · nullableOptional

The date when the user was removed from the access list

emailstringRequired

The e-mail address of the visitor

mobilestringRequired

The mobile phone number of the visitor

firstNamestringRequired

The first name of the visitor

lastNamestringRequired

The last name of the visitor

birthDatestringRequired

The birth date of the user. The format is YYYY-MM-DD

companyNamestring · nullableOptional

The company name of the visitor

citystring · nullableOptional

The city of the visitor

countryEnstringRead-onlyRequired

The country name of the visitor

adminNotesReadOnlystring · nullableOptional

Notes for admins

checkedstring · nullableOptional

Was the user checked?

createdByinteger · integerRead-onlyRequired

ID of user creator

newEntryinteger · integerRead-onlyRequired

Is this a new entry

temporaryAccessinteger · integer · nullableOptional

temporaryAccess If this field is set to 1, then has the visitor a temporary access

fingerPrintIdinteger · integer · nullableOptional

The print ID from Syntegro system

printMadestring · nullableOptional

Was the print made

visitRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can add a temporary access for other visitor

permanentRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can request a permanent access for other visitor

syntegroEmployeeCodestring · nullableOptional

The Syntegro employee code of visitor

statusstringRead-onlyRequired

The status of the visitor (granted, pending, denied, revoked, suspended)

403

Invalid credentials

500

Internal Server Error

application/json

post

/v3/colocation/access

POST /v3/colocation/access HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "visitorId": 1,
  "email": "text",
  "mobile": "text",
  "firstName": "text",
  "lastName": "text",
  "birthDate": "text",
  "companyName": "text",
  "colocatedAccessServer": [
    {
      "coloserverId": 1,
      "rackname": "text"
    }
  ],
  "temporaryAccess": 1,
  "visitRequester": 1,
  "permanentRequester": 1
}

[
  {
    "id": 1,
    "visitorId": 1,
    "datacenterId": 1,
    "dateverified": "text",
    "dateonlist": "text",
    "dateofflist": "text",
    "email": "text",
    "mobile": "text",
    "firstName": "text",
    "lastName": "text",
    "birthDate": "text",
    "companyName": "text",
    "city": "text",
    "countryEn": "text",
    "colocatedAccessServers": [
      {
        "coloserverId": 1,
        "rackname": "text"
      }
    ],
    "adminNotesReadOnly": "text",
    "accountDocument": [
      {
        "id": 1,
        "documentType": 1,
        "documentNumber": "text",
        "documentExpiration": "text"
      }
    ],
    "checked": "text",
    "createdBy": 1,
    "newEntry": 1,
    "temporaryAccess": 1,
    "fingerPrintId": 1,
    "printMade": "text",
    "visitRequester": 1,
    "permanentRequester": 1,
    "syntegroEmployeeCode": "text",
    "status": "text"
  }
]

Get colocation access by ID

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

ID of the access

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of colocation access request

visitorIdinteger · integerRequired

The ID of the user

datacenterIdinteger · integer · nullableOptional

The ID of data center

dateverifiedstring · nullableOptional

The date when the user was verified

dateonliststring · nullableOptional

The date when the user was added to the access list

dateoffliststring · nullableOptional

The date when the user was removed from the access list

emailstringRequired

The e-mail address of the visitor

mobilestringRequired

The mobile phone number of the visitor

firstNamestringRequired

The first name of the visitor

lastNamestringRequired

The last name of the visitor

birthDatestringRequired

The birth date of the user. The format is YYYY-MM-DD

companyNamestring · nullableOptional

The company name of the visitor

citystring · nullableOptional

The city of the visitor

countryEnstringRead-onlyRequired

The country name of the visitor

adminNotesReadOnlystring · nullableOptional

Notes for admins

checkedstring · nullableOptional

Was the user checked?

createdByinteger · integerRead-onlyRequired

ID of user creator

newEntryinteger · integerRead-onlyRequired

Is this a new entry

temporaryAccessinteger · integer · nullableOptional

temporaryAccess If this field is set to 1, then has the visitor a temporary access

fingerPrintIdinteger · integer · nullableOptional

The print ID from Syntegro system

printMadestring · nullableOptional

Was the print made

visitRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can add a temporary access for other visitor

permanentRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can request a permanent access for other visitor

syntegroEmployeeCodestring · nullableOptional

The Syntegro employee code of visitor

statusstringRead-onlyRequired

The status of the visitor (granted, pending, denied, revoked, suspended)

403

Invalid credentials

404

Invalid accessId

500

Internal Server Error

application/json

get

/v3/colocation/access/{accessId}

GET /v3/colocation/access/{accessId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "visitorId": 1,
    "datacenterId": 1,
    "dateverified": "text",
    "dateonlist": "text",
    "dateofflist": "text",
    "email": "text",
    "mobile": "text",
    "firstName": "text",
    "lastName": "text",
    "birthDate": "text",
    "companyName": "text",
    "city": "text",
    "countryEn": "text",
    "colocatedAccessServers": [
      {
        "coloserverId": 1,
        "rackname": "text"
      }
    ],
    "adminNotesReadOnly": "text",
    "accountDocument": [
      {
        "id": 1,
        "documentType": 1,
        "documentNumber": "text",
        "documentExpiration": "text"
      }
    ],
    "checked": "text",
    "createdBy": 1,
    "newEntry": 1,
    "temporaryAccess": 1,
    "fingerPrintId": 1,
    "printMade": "text",
    "visitRequester": 1,
    "permanentRequester": 1,
    "syntegroEmployeeCode": "text",
    "status": "text"
  }
]

Update colocation access

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

ID of the access

Body

idinteger · integerRead-onlyRequired

The ID of colocation access request

visitorIdinteger · integerOptional

The ID of the visitor

emailstringRequired

The e-mail address of the visitor

mobilestringRequired

The mobile phone number of the visitor

firstNamestringRequired

The first name of the visitor

lastNamestringRequired

The last name of the visitor

birthDatestringRequired

The birth date of the visitor

companyNamestringRequired

The company name of visitor

temporaryAccessinteger · integer · nullableOptional

If this field is set to 1, then the visitor has a temporary access

visitRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can add a temporary access for other visitor

permanentRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can request a permanent access for other visitor

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of colocation access request

visitorIdinteger · integerRequired

The ID of the user

datacenterIdinteger · integer · nullableOptional

The ID of data center

dateverifiedstring · nullableOptional

The date when the user was verified

dateonliststring · nullableOptional

The date when the user was added to the access list

dateoffliststring · nullableOptional

The date when the user was removed from the access list

emailstringRequired

The e-mail address of the visitor

mobilestringRequired

The mobile phone number of the visitor

firstNamestringRequired

The first name of the visitor

lastNamestringRequired

The last name of the visitor

birthDatestringRequired

The birth date of the user. The format is YYYY-MM-DD

companyNamestring · nullableOptional

The company name of the visitor

citystring · nullableOptional

The city of the visitor

countryEnstringRead-onlyRequired

The country name of the visitor

adminNotesReadOnlystring · nullableOptional

Notes for admins

checkedstring · nullableOptional

Was the user checked?

createdByinteger · integerRead-onlyRequired

ID of user creator

newEntryinteger · integerRead-onlyRequired

Is this a new entry

temporaryAccessinteger · integer · nullableOptional

temporaryAccess If this field is set to 1, then has the visitor a temporary access

fingerPrintIdinteger · integer · nullableOptional

The print ID from Syntegro system

printMadestring · nullableOptional

Was the print made

visitRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can add a temporary access for other visitor

permanentRequesterinteger · integer · nullableOptional

If this field is set to 1, then this visitor can request a permanent access for other visitor

syntegroEmployeeCodestring · nullableOptional

The Syntegro employee code of visitor

statusstringRead-onlyRequired

The status of the visitor (granted, pending, denied, revoked, suspended)

403

Invalid credentials

422

Invalid accessId

500

Internal Server Error

application/json

put

/v3/colocation/access/{accessId}

PUT /v3/colocation/access/{accessId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "visitorId": 1,
  "email": "text",
  "mobile": "text",
  "firstName": "text",
  "lastName": "text",
  "birthDate": "text",
  "companyName": "text",
  "colocatedAccessServer": [
    {
      "coloserverId": 1,
      "rackname": "text"
    }
  ],
  "temporaryAccess": 1,
  "visitRequester": 1,
  "permanentRequester": 1
}

[
  {
    "id": 1,
    "visitorId": 1,
    "datacenterId": 1,
    "dateverified": "text",
    "dateonlist": "text",
    "dateofflist": "text",
    "email": "text",
    "mobile": "text",
    "firstName": "text",
    "lastName": "text",
    "birthDate": "text",
    "companyName": "text",
    "city": "text",
    "countryEn": "text",
    "colocatedAccessServers": [
      {
        "coloserverId": 1,
        "rackname": "text"
      }
    ],
    "adminNotesReadOnly": "text",
    "accountDocument": [
      {
        "id": 1,
        "documentType": 1,
        "documentNumber": "text",
        "documentExpiration": "text"
      }
    ],
    "checked": "text",
    "createdBy": 1,
    "newEntry": 1,
    "temporaryAccess": 1,
    "fingerPrintId": 1,
    "printMade": "text",
    "visitRequester": 1,
    "permanentRequester": 1,
    "syntegroEmployeeCode": "text",
    "status": "text"
  }
]

Delete colocation access by ID

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

Responses

204

No Content

403

Invalid credentials

404

Invalid accessId

500

Internal Server Error

application/json

delete

/v3/colocation/access/{accessId}

DELETE /v3/colocation/access/{accessId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Revoke access by access ID

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

Responses

204

No Content

403

Invalid credentials

404

Invalid accessId

500

Internal Server Error

application/json

put

/v3/colocation/access/{accessId}/revoke

PUT /v3/colocation/access/{accessId}/revoke HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Reactivate access by access ID

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

Responses

204

No Content

403

Invalid credentials

404

Invalid accessId

500

Internal Server Error

application/json

put

/v3/colocation/access/{accessId}/reactivate

PUT /v3/colocation/access/{accessId}/reactivate HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get all the documents of the DC access visitor

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

Responses

200

application/json

idinteger · integerRead-onlyRequired

ID of the document

documentTypeinteger · integerRequired

Type of the document

documentNumberstringRequired

Number of document

documentExpirationstringRequired

Expiration date of document

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/colocation/access/{accessId}/document

GET /v3/colocation/access/{accessId}/document HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "documentType": 1,
    "documentNumber": "text",
    "documentExpiration": "text"
  }
]

Create a new document for the visitor accessing DC

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

Body

idinteger · integerRead-onlyRequired

ID of the document

documentTypeinteger · integerRequired

Type of the document

documentNumberstringRequired

Number of document

documentExpirationstringRequired

Expiration date of document

Responses

200

application/json

idinteger · integerRead-onlyRequired

ID of the document

documentTypeinteger · integerRequired

Type of the document

documentNumberstringRequired

Number of document

documentExpirationstringRequired

Expiration date of document

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/colocation/access/{accessId}/document

POST /v3/colocation/access/{accessId}/document HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "documentType": 1,
  "documentNumber": "text",
  "documentExpiration": "text"
}

[
  {
    "id": 1,
    "documentType": 1,
    "documentNumber": "text",
    "documentExpiration": "text"
  }
]

Get a document of the DC access visitor

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

documentIdintegerRequired

The ID of the document to view

Responses

200

application/json

idinteger · integerRead-onlyRequired

ID of the document

documentTypeinteger · integerRequired

Type of the document

documentNumberstringRequired

Number of document

documentExpirationstringRequired

Expiration date of document

403

Invalid credentials

404

Invalid document id

500

Internal Server Error

application/json

get

/v3/colocation/access/{accessId}/document/{documentId}

GET /v3/colocation/access/{accessId}/document/{documentId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "documentType": 1,
    "documentNumber": "text",
    "documentExpiration": "text"
  }
]

Update document of the DC access visitor

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

documentIdintegerRequired

The ID of the document to update

Body

idinteger · integerRead-onlyRequired

ID of the document

documentTypeinteger · integerRequired

Type of the document

documentNumberstringRequired

Number of document

documentExpirationstringRequired

Expiration date of document

Responses

200

application/json

idinteger · integerRead-onlyRequired

ID of the document

documentTypeinteger · integerRequired

Type of the document

documentNumberstringRequired

Number of document

documentExpirationstringRequired

Expiration date of document

403

Invalid credentials

404

Invalid API key access ID

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/colocation/access/{accessId}/document/{documentId}

PUT /v3/colocation/access/{accessId}/document/{documentId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "documentType": 1,
  "documentNumber": "text",
  "documentExpiration": "text"
}

[
  {
    "id": 1,
    "documentType": 1,
    "documentNumber": "text",
    "documentExpiration": "text"
  }
]

Delete a document of the visitor accessing DC

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

accessIdintegerRequired

The ID of the access

documentIdintegerRequired

The ID of the document to delete

Responses

204

No Content

403

Invalid credentials

404

Invalid document id

500

Internal Server Error

application/json

delete

/v3/colocation/access/{accessId}/document/{documentId}

DELETE /v3/colocation/access/{accessId}/document/{documentId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Last updated 2 months ago

Was this helpful?

hashtagGet list of all colocated servers

hashtagGet the colocated server by ID

hashtagUpdate the colocated server by ID

hashtagGet all the invoices for a specific colocated service

hashtagGet all the PDUs for a specific colocated service

hashtagGet the traffic usage data for the last day

hashtagGet the traffic usage graph (last year)

hashtagGet the traffic usage graph (last 30 days)

hashtagGet the traffic usage graph (last 7 days)

hashtagGet the traffic usage graph (last 24 hours)

hashtagGet all the alerts linked to the colocated server

hashtagCreate alert for the colocated server

hashtagUpdate colocated server alert

hashtagDelete colocated server alert

hashtagCancel the colocated server

hashtagRevert the cancellation of a colocated server

hashtagSet RDNS hostname for IP

hashtagGet list of all colocation access

hashtagCreate a new colocation access request

hashtagGet colocation access by ID

hashtagUpdate colocation access

hashtagDelete colocation access by ID

hashtagRevoke access by access ID

hashtagReactivate access by access ID

hashtagGet all the documents of the DC access visitor

hashtagCreate a new document for the visitor accessing DC

hashtagGet a document of the DC access visitor

hashtagUpdate document of the DC access visitor

hashtagDelete a document of the visitor accessing DC

Get list of all colocated servers

Get the colocated server by ID

Update the colocated server by ID

Get all the invoices for a specific colocated service

Get all the PDUs for a specific colocated service

Get the traffic usage data for the last day

Get the traffic usage graph (last year)

Get the traffic usage graph (last 30 days)

Get the traffic usage graph (last 7 days)

Get the traffic usage graph (last 24 hours)

Get all the alerts linked to the colocated server

Create alert for the colocated server

Update colocated server alert

Delete colocated server alert

Cancel the colocated server

Revert the cancellation of a colocated server

Set RDNS hostname for IP

Get list of all colocation access

Create a new colocation access request

Get colocation access by ID

Update colocation access

Delete colocation access by ID

Revoke access by access ID

Reactivate access by access ID

Get all the documents of the DC access visitor

Create a new document for the visitor accessing DC

Get a document of the DC access visitor

Update document of the DC access visitor

Delete a document of the visitor accessing DC