Traffic

Traffic data

get

Get a high-granularity list of utilization resources for current month by default

Authorizations

basicAuthbearerAuth

AuthorizationstringRequired

Path parameters

contractintegerRequired

Contract number

Pattern: [0-9]{5,10}

Query parameters

ipbooleanOptional

Provide report grouped by IPs

outputstring · enumOptional

The output format (object, array, CSV or all of them)

Default: allPossible values:

Responses

200

Result data

application/json

or

401

Unauthorized

application/json

403

Forbidden

application/json

404

The contract not found or doesn't belong to the user

application/json

422

Wrong period format specified

application/json

500

Unexpected internal server error

application/json

get

/{contract}/traffic

HTTPcURLJavaScriptPython

GET /billing/{contract}/traffic HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "type": "vdc",
  "trafficObj": {
    "ip": [
      {
        "vdcUUID": "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
        "vdcName": "Main VDC",
        "ip": "157.97.107.158",
        "dates": [
          {
            "Date": "2019-08-01",
            "In": "0.7254719333723187",
            "Out": "0.22908576484769583"
          },
          {
            "Date": "2019-08-02",
            "In": "1.2738572908565402",
            "Out": "0.24987032916396856"
          },
          {
            "Date": "2019-08-03",
            "In": "0.3472602190449834",
            "Out": 0.23526559863239527
          }
        ]
      },
      {
        "vdcUUID": "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
        "vdcName": "Main VDC",
        "ip": "157.97.107.157",
        "dates": [
          {
            "Date": "2019-08-01",
            "In": "0.0443666810169816",
            "Out": "0.15891019999980927"
          },
          {
            "Date": "2019-08-02",
            "In": "0.04538741987198591",
            "Out": "0.16538945399224758"
          },
          {
            "Date": "2019-08-03",
            "In": "0.04669629875570536",
            "Out": "0.16466102469712496"
          }
        ]
      }
    ]
  },
  "trafficArr": [
    [
      "In/Out",
      "VDC UUID",
      "VDC Name",
      "IP",
      "2019-08-01",
      "2019-08-02",
      "2019-08-03"
    ],
    [
      "In",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.158",
      "0.7254719333723187",
      "1.2738572908565402",
      "0.3472602190449834"
    ],
    [
      "Out",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.158",
      "0.22908576484769583",
      "0.24987032916396856",
      "0.23526559863239527"
    ],
    [
      "In",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.157",
      "0.0443666810169816",
      "0.04538741987198591",
      "0.04669629875570536"
    ],
    [
      "Out",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.157",
      "0.15891019999980927",
      "0.16538945399224758",
      "0.16466102469712496"
    ]
  ],
  "traffic": [
    "In/Out,VDC UUID,VDC Name,IP,2019-08-01,2019-08-02,2019-08-03",
    "In,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.158,0.7254719333723187,1.2738572908565402,0.3472602190449834",
    "Out,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.158,0.22908576484769583,0.24987032916396856,0.23526559863239527",
    "In,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.157,0.0443666810169816,0.04538741987198591,0.04669629875570536",
    "Out,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.157,0.15891019999980927,0.16538945399224758,0.16466102469712496"
  ]
}

get

Get a high-granularity list of utilization resources for a certain period

Authorizations

basicAuthbearerAuth

AuthorizationstringRequired

Path parameters

contractintegerRequired

Contract number

Pattern: [0-9]{5,10}

periodstringRequired

Period of interest in format YYYY-MM

Example: 2020-01Pattern: ^(\d{4}-\d{2}|null)$

Query parameters

ipbooleanOptional

Provide report grouped by IPs

outputstring · enumOptional

The output format (object, array, CSV or all of them)

Default: allPossible values:

Responses

200

Result data

application/json

or

401

Unauthorized

application/json

403

Forbidden

application/json

404

The contract not found or doesn't belong to the user

application/json

422

Wrong period format specified

application/json

500

Unexpected internal server error

application/json

get

/{contract}/traffic/{period}

HTTPcURLJavaScriptPython

GET /billing/{contract}/traffic/{period} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "type": "vdc",
  "trafficObj": {
    "ip": [
      {
        "vdcUUID": "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
        "vdcName": "Main VDC",
        "ip": "157.97.107.158",
        "dates": [
          {
            "Date": "2019-08-01",
            "In": "0.7254719333723187",
            "Out": 0.22908576484769583
          },
          {
            "Date": "2019-08-02",
            "In": "1.2738572908565402",
            "Out": 0.24987032916396856
          },
          {
            "Date": "2019-08-03",
            "In": "0.3472602190449834",
            "Out": 0.23526559863239527
          }
        ]
      },
      {
        "vdcUUID": "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
        "vdcName": "Main VDC",
        "ip": "157.97.107.157",
        "dates": [
          {
            "Date": "2019-08-01",
            "In": 0.0443666810169816,
            "Out": 0.15891019999980927
          },
          {
            "Date": "2019-08-02",
            "In": 0.04538741987198591,
            "Out": 0.16538945399224758
          },
          {
            "Date": "2019-08-03",
            "In": 0.04669629875570536,
            "Out": 0.16466102469712496
          }
        ]
      }
    ]
  },
  "trafficArr": [
    [
      "In/Out",
      "VDC UUID",
      "VDC Name",
      "IP",
      "2019-08-01",
      "2019-08-02",
      "2019-08-03"
    ],
    [
      "In",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.158",
      "0.7254719333723187",
      "1.2738572908565402",
      "0.3472602190449834"
    ],
    [
      "Out",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.158",
      "0.22908576484769583",
      "0.24987032916396856",
      "0.23526559863239527"
    ],
    [
      "In",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.157",
      "0.0443666810169816",
      "0.04538741987198591",
      "0.04669629875570536"
    ],
    [
      "Out",
      "f2c2edf6-49f7-4687-8100-872b4d02ddcc",
      "Main VDC",
      "157.97.107.157",
      "0.15891019999980927",
      "0.16538945399224758",
      "0.16466102469712496"
    ]
  ],
  "traffic": [
    "In/Out,VDC UUID,VDC Name,IP,2019-08-01,2019-08-02,2019-08-03",
    "In,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.158,0.7254719333723187,1.2738572908565402,0.3472602190449834",
    "Out,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.158,0.22908576484769583,0.24987032916396856,0.23526559863239527",
    "In,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.157,0.0443666810169816,0.04538741987198591,0.04669629875570536",
    "Out,f2c2edf6-49f7-4687-8100-872b4d02ddcc,Main VDC,157.97.107.157,0.15891019999980927,0.16538945399224758,0.16466102469712496"
  ]
}